Docs

You are viewing an archived version of the docs.Go to latest version

createEmailAddress()

Creates an EmailAddress for the specified user.

function createEmailAddress: (params: CreateEmailAddressParams) => Promise<EmailAddress>;
  • 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.

  • Name
    verified?
    Type
    boolean
    Description

    Whether or not the email address is verified.

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

console.log(response);
/*
_EmailAddress {
  id: 'idn_2bxnrjq6IbzcU4iOR5i13v29VPK',
  emailAddress: 'testclerk123@gmail.com',
  verification: _Verification {
    status: 'verified',
    strategy: 'admin',
    externalVerificationRedirectURL: null,
    attempts: null,
    expireAt: null,
    nonce: null
  },
  linkedTo: []
}
*/

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 details.

Feedback

What did you think of this content?

Last updated on