Docs

deletePhoneNumber()

Deletes a PhoneNumber for a given ID.

function deletePhoneNumber: (phoneNumberId: string) => Promise<PhoneNumber>;
  • Name
    phoneNumberId
    Type
    string
    Description

    The ID of the phone number to delete.

const phoneNumberId = 'idn_2bxwW8Fa5Y53QcESgQ6HkTo0cgh';

const response = await clerkClient.phoneNumbers.deletePhoneNumber(phoneNumberId);

console.log(response);
/*
_DeletedObject {
  object: 'phone_number',
  id: 'idn_2bxwW8Fa5Y53QcESgQ6HkTo0cgh',
  slug: null,
  deleted: true
}
*/

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/phone_numbers/{phone_number_id}. See the BAPI reference for more details.

Feedback

What did you think of this content?