Sign in
Phone Numbers

Update a phone number

Updates a phone number

patch/phone_numbers/{phone_number_id}

Path parameters

phone_number_idstring required

The ID of the phone number to update

Request body

verifiedboolean nullable

The phone number will be marked as verified.

primaryboolean nullable

Set this phone number as the primary phone number for the user.

reserved_for_second_factorboolean nullable

Set this phone number as 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.

Response

Success

idstring
object'phone_number' required

String representing the object's type. Objects of the same type share the same value.

phone_numberstring required
reserved_for_second_factorboolean
default_second_factorboolean
reservedboolean required
backup_codesstring[] nullable
created_atinteger required

Unix timestamp of creation

updated_atinteger required

Unix timestamp of creation

Changes

Changed in 1 of the 15 revisions of this API.1

  • 11bb1ccf4b7d1See the full diff
    • ○

      added the optional property verification/oneOf[verification_otp]/channel to the response with the 200 status

      response-optional-property-added