Skip to main content

deletePhoneNumber()

Deletes the given phone number.

Returns the DeletedObject object.

function deletePhoneNumber(phoneNumberId: string): Promise<DeletedObject>

Parameters

  • Name
    phoneNumberId
    Type
    string
    Description

    The ID of the phone number to delete.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const phoneNumberId = 'idn_123'

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

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 information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub