`deletePhoneNumber()`

Deletes a PhoneNumber for a given ID.


function deletePhoneNumber: (phoneNumberId: string) => Promise<PhoneNumber>;

`deletePhoneNumber()` parameters

Name	Type	Description
`phoneNumberId`	`string`	The ID of the phone number to delete.

`deletePhoneNumber()` example


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(opens in a new tab) for more details.

deletePhoneNumber() parameters

deletePhoneNumber() example

Backend API (BAPI) endpoint

`deletePhoneNumber()` parameters

`deletePhoneNumber()` example