Change user phone number
POST/user/phone-number/change
POST
/user/phone-number/change
Request to change the authenticated user’s phone number. A one-time password is sent
via SMS to the new phone number; complete the change by calling
/user/phone-number/change/verify with the OTP. The current phone_number is left
unchanged until verification succeeds. Requires elevated permissions.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”New phone number to verify and bind to the user
object
newPhoneNumber
required
New phone number to bind to the user once verified via SMS OTP
string
Example
+123456789Responses
Section titled “Responses”Phone number change requested. An SMS with a verification code has been sent to the new phone number.
string
default
Section titled “default”An error occurred while processing the request
Standardized error response
object
status
required
HTTP status error code
integer
Example
400message
required
Human-friendly error message
string
Example
Invalid email formaterror
required
Error code identifying the specific application error
string