Skip to content

Update phone number

PATCH
/users/phone

Updates the phone number for the authenticated user. Supports both legacy OTP flow and new MFA flow.

Legacy Flow (requestToken):

  1. User verifies OTP and gets requestToken
  2. Send requestToken in request body
  3. Token is validated and phone updated

MFA Flow (phoneNumber + feature flag enabled):

  1. Complete MFA flow: phone_update_flow with otp_email challenge
  2. Send phoneNumber in request body + MFA token in header
  3. MFA middleware validates, phone updated
X-GOTU-MFA-Token
string

MFA token from completed phone_update_flow (required for MFA flow)

UpdatePhoneRequest - either phoneNumber (MFA) or requestToken (legacy)

object
phoneNumber

New MFA flow

string
+1234567890
requestToken

Legacy OTP flow

string
eyJhbGciOiJIUzI1NiJ9...

No Content

Bad request

object
error
string
some meaningful error message

Unauthorized

object
error
string
some meaningful error message

Forbidden - MFA not completed or invalid token

object
error
string
some meaningful error message

Internal server error

object
error
string
some meaningful error message