Skip to main content
Docs
Dashboard

updatePhoneNumber()

Updates a PhoneNumber.

function updatePhoneNumber(
  phoneNumberId: string,
  params: UpdatePhoneNumberParams,
): Promise<PhoneNumber>

UpdatePhoneNumberParams

  • Name
    primary?
    Type
    boolean
    Description

    Whether or not to set the phone number as the user's primary phone number.

  • Name
    verified?
    Type
    boolean
    Description

    Whether or not the phone number is verified.

  • Name
    reservedForSecondFactor
    Type
    boolean
    Description

    Whether or not the phone number is reserved for multi-factor authentication. The phone number must also be verified. If there are no other reserved second factors, the phone number will be set as the default second factor.

Example

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const phoneNumberId = 'idn_123'

const params = { verified: false }

const response = await clerkClient.phoneNumbers.updatePhoneNumber(phoneNumberId, params)

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on