deleteEmailAddress()
Deletes an EmailAddress.
function deleteEmailAddress(emailAddressId: string): Promise<EmailAddress>- Name
emailAddressId- Type
string- Description
The ID of the email address to delete.
const emailAddressId = 'idn_123'
const response = await clerkClient.emailAddresses.deleteEmailAddress(emailAddressId)
console.log(response)
/*
_DeletedObject {
object: 'email_address',
id: 'idn_123',
slug: null,
deleted: true
}
*/Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint DELETE/email_addresses/{email_address_id}. See the BAPI reference for more details.
Feedback
Last updated on