Skip to main content
Docs

createEmailAddress()

Creates an EmailAddressJavaScript Icon for the specified user.

function createEmailAddress(params: CreateEmailAddressParams): Promise<EmailAddress>

CreateEmailAddressParams

  • Name
    userId
    Type
    string
    Description

    The ID of the user to create the email address for.

  • Name
    emailAddress
    Type
    string
    Description

    The email address to assign to the specified user.

  • Name
    primary?
    Type
    boolean
    Description

    Whether or not to set the email address as the user's primary email address. Defaults to false, unless it is the first email address.

  • Name
    verified?
    Type
    boolean
    Description

    Whether or not the email address is verified.

Example

Note

Importing clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const response = await clerkClient.emailAddresses.createEmailAddress({
  userId: 'user_123',
  emailAddress: 'testclerk123@gmail.com',
  primary: true,
  verified: true,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/email_addresses. See the BAPI reference for more information.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on