← Clerk

Update User with Clerk API

Pipedream makes it easy to connect APIs for Clerk and 2,200+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Update User with the Clerk API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Update User with the Clerk API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Update User action
    1. Connect your Clerk account
    2. Select a User Id
    3. Optional- Configure External Id
    4. Optional- Configure First Name
    5. Optional- Configure Last Name
    6. Optional- Select a Primary Email Address Id
    7. Optional- Configure Notify Primary Email Address Changed
    8. Optional- Select a Primary Phone Number Id
    9. Optional- Select a Primary Web3 Wallet Id
    10. Optional- Configure Username
    11. Optional- Configure Profile Image Id
    12. Optional- Configure Password
    13. Optional- Configure Skip Password Checks
    14. Optional- Configure Sign Out Of Other Sessions
    15. Optional- Configure TOTP Secret
    16. Optional- Configure Backup Codes
    17. Optional- Configure Public Metadata
    18. Optional- Configure Private Metadata
    19. Optional- Configure Unsafe Metadata
    20. Optional- Configure Delete Self Enable
    21. Optional- Configure Create Organization Enabled
    22. Optional- Configure Created At
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Update User with Clerk API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Clerk
 
Try it
Update User with Clerk API on New Submission from Typeform API
Typeform + Clerk
 
Try it
Update User with Clerk API on Custom Events from Zoom API
Zoom + Clerk
 
Try it
Update User with Clerk API on New Submission (Instant) from Jotform API
Jotform + Clerk
 
Try it
Update User with Clerk API on New Scheduled Tasks from Pipedream API
Pipedream + Clerk
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Update User on Clerk
Description:Update a user's attributes. You can set the user's primary contact identifiers (email address and phone numbers) by updating the `Primary Email Address Id` and `Primary Phone Number Id` attributes respectively. Both IDs should correspond to verified identifications that belong to the user. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Users#operation/CreateUser)
Version:0.0.1
Key:clerk-update-user

Code

import clerk from "../../clerk.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "clerk-update-user",
  name: "Update User",
  version: "0.0.1",
  description: "Update a user's attributes. You can set the user's primary contact identifiers (email address and phone numbers) by updating the `Primary Email Address Id` and `Primary Phone Number Id` attributes respectively. Both IDs should correspond to verified identifications that belong to the user. [See the documentation](https://clerk.com/docs/reference/backend-api/tag/Users#operation/CreateUser)",
  type: "action",
  props: {
    clerk,
    userId: {
      propDefinition: [
        clerk,
        "userId",
      ],
    },
    externalId: {
      propDefinition: [
        clerk,
        "externalId",
      ],
      optional: true,
    },
    firstName: {
      propDefinition: [
        clerk,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        clerk,
        "lastName",
      ],
      optional: true,
    },
    primaryEmailAddressId: {
      propDefinition: [
        clerk,
        "primaryEmailAddressId",
        ({ userId }) => ({
          userId,
        }),
      ],
      optional: true,
    },
    notifyPrimaryEmailAddressChanged: {
      type: "boolean",
      label: "Notify Primary Email Address Changed",
      description: "If set to `true`, the user will be notified that their primary email address has changed. By default, no notification is sent.",
      optional: true,
    },
    primaryPhoneNumberId: {
      propDefinition: [
        clerk,
        "primaryPhoneNumberId",
        ({ userId }) => ({
          userId,
        }),
      ],
      optional: true,
    },
    primaryWeb3WalletId: {
      propDefinition: [
        clerk,
        "primaryWeb3WalletId",
        ({ userId }) => ({
          userId,
        }),
      ],
      optional: true,
    },
    username: {
      propDefinition: [
        clerk,
        "username",
      ],
      optional: true,
    },
    profileImageId: {
      type: "string",
      label: "Profile Image Id",
      description: "The ID of the image to set as the user's profile image",
      optional: true,
    },
    password: {
      propDefinition: [
        clerk,
        "password",
      ],
      optional: true,
    },
    skipPasswordChecks: {
      propDefinition: [
        clerk,
        "skipPasswordChecks",
      ],
      optional: true,
    },
    signOutOfOtherSessions: {
      type: "boolean",
      label: "Sign Out Of Other Sessions",
      description: "Set to `true` to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a `password`.",
      optional: true,
    },
    totpSecret: {
      propDefinition: [
        clerk,
        "totpSecret",
      ],
      optional: true,
    },
    backupCodes: {
      propDefinition: [
        clerk,
        "backupCodes",
      ],
      optional: true,
    },
    publicMetadata: {
      propDefinition: [
        clerk,
        "publicMetadata",
      ],
      optional: true,
    },
    privateMetadata: {
      propDefinition: [
        clerk,
        "privateMetadata",
      ],
      optional: true,
    },
    unsafeMetadata: {
      propDefinition: [
        clerk,
        "unsafeMetadata",
      ],
      optional: true,
    },
    deleteSelfEnable: {
      type: "boolean",
      label: "Delete Self Enable",
      description: "If `true`, the user can delete themselves with the Frontend API.",
      optional: true,
    },
    createOrganizationEnabled: {
      type: "boolean",
      label: "Create Organization Enabled",
      description: "If true, the user can create organizations with the Frontend API.",
      optional: true,
    },
    createdAt: {
      propDefinition: [
        clerk,
        "createdAt",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      clerk,
      userId,
    } = this;

    const response = await clerk.updateUser({
      $,
      userId,
      data: {
        external_id: this.externalId,
        first_name: this.firstName,
        last_name: this.lastName,
        primary_email_address_id: this.primaryEmailAddressId,
        notify_primary_email_address_changed: this.notifyPrimaryEmailAddressChanged,
        primary_phone_number_id: this.primaryPhoneNumberId,
        primary_web3_wallet_id: this.primaryWeb3WalletId,
        username: this.username,
        profile_image_id: this.profileImageId,
        password: this.password,
        skip_password_checks: this.skipPasswordChecks,
        sign_out_of_other_sessions: this.signOutOfOtherSessions,
        totp_secret: this.totpSecret,
        backup_codes: parseObject(this.backupCodes),
        public_metadata: parseObject(this.publicMetadata),
        private_metadata: parseObject(this.privateMetadata),
        unsafe_metadata: parseObject(this.unsafeMetadata),
        delete_self_enabled: this.deleteSelfEnable,
        create_organization_enabled: this.createOrganizationEnabled,
        created_at: this.createdAt,
      },
    });

    $.export("$summary", `The user with Id: ${userId} was successfully updated!`);
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
ClerkclerkappThis component uses the Clerk app.
User IduserIdstringSelect a value from the drop down menu.
External IdexternalIdstring

The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance.

First NamefirstNamestring

The first name to assign to the user.

Last NamelastNamestring

The last name to assign to the user.

Primary Email Address IdprimaryEmailAddressIdstringSelect a value from the drop down menu.
Notify Primary Email Address ChangednotifyPrimaryEmailAddressChangedboolean

If set to true, the user will be notified that their primary email address has changed. By default, no notification is sent.

Primary Phone Number IdprimaryPhoneNumberIdstringSelect a value from the drop down menu.
Primary Web3 Wallet IdprimaryWeb3WalletIdstringSelect a value from the drop down menu.
Usernameusernamestring

The username to give to the user. It must be unique across your instance.

Profile Image IdprofileImageIdstring

The ID of the image to set as the user's profile image

Passwordpasswordstring

The plaintext password to give to the user. Must be at least 8 characters long, and can not be in any list of hacked passwords.

Skip Password ChecksskipPasswordChecksboolean

When set to true all password checks are skipped. It is recommended to use this method only when migrating plaintext passwords to Clerk. Upon migration the user base should be prompted to pick stronger password.

Sign Out Of Other SessionssignOutOfOtherSessionsboolean

Set to true to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a password.

TOTP SecrettotpSecretstring

In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it.

Backup CodesbackupCodesstring[]

If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest.

Public MetadatapublicMetadataobject

Metadata saved on the user, that is visible to both your Frontend and Backend APIs.

Private MetadataprivateMetadataobject

Metadata saved on the user, that is only visible to your Backend API.

Unsafe MetadataunsafeMetadataobject

Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe.

Delete Self EnabledeleteSelfEnableboolean

If true, the user can delete themselves with the Frontend API.

Create Organization EnabledcreateOrganizationEnabledboolean

If true, the user can create organizations with the Frontend API.

Created AtcreatedAtstring

A custom date/time denoting when the user signed up to the application, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z).

Authentication

Clerk uses API keys for authentication. When you connect your Clerk account, Pipedream securely stores the keys so you can easily authenticate to Clerk APIs in both code and no-code steps.

About Clerk

Drop-in authentication for React and React Native.

More Ways to Use Clerk

Actions

Create User with the Clerk API

Creates a new user. Your user management settings determine how you should setup your user model. See the documentation

 
Try it
Create User Invitation with the Clerk API

Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error. See the documentation

 
Try it
Delete User with the Clerk API

Delete the specified user. See the documentation

 
Try it
Get User with the Clerk API

Retrieve the details of a specific user. See the documentation

 
Try it
Get User Memberships with the Clerk API

Retrieve a list of the user's organization memberships. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,200+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.