updateEmailAddress()
Updates an .
function updateEmailAddress(
emailAddressId: string,
params: UpdateEmailAddressParams,
): Promise<EmailAddress>- 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 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.
Feedback
Last updated on