updatePhoneNumber()
Updates a PhoneNumber
.
- 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
Let's start with a PhoneNumber
object that looks like this:
Let's update the phone number to be unverified:
As you can see in the response, the phone number is now unverified.
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 details.
Feedback
Last updated on