UpdateEmailAddressParams
Example
Backend API (BAPI) endpoint

Edit this page on GitHub

Open in ChatGPT

`updateEmailAddress()`

Updates an EmailAddress.

function updateEmailAddress(
  emailAddressId: string,
  params: UpdateEmailAddressParams,
): Promise<EmailAddress>

`UpdateEmailAddressParams`

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.

Example

Note

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

const emailAddressId = 'idn_123'

const params = { verified: false }

const response = await clerkClient.emailAddresses.updateEmailAddress(emailAddressId, params)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint PATCH/email_addresses/{email_address_id}. See the BAPI reference for more information.

Edit this page on GitHub

Last updated on Feb 20, 2025