Set Phone

How to set a user’s phone number through the CoSync REST API #

Set the phone number of the user. This will send the new phone number a code, and set the phoneVerified flag to false. The number must be in a valid E. 164 format.

URL # 
    /api/appuser/setPhone
Method # 
    POST
Headers # 
    access-token: "<Access Token>"
Data Parameter # 
    {
        phone: "<user phone number>",
    }

Response: #

Success: #

StatusCode: # 
    200 (OK)
Contents: # 
    true

Error: #

StatusCode: # 
    400 (BAD REQUEST)
    500 (INTERNAL SERVER ERROR)
Content: # 
    {
        code: "<internal error code>",
        message: "<readable error description>"
    }

The internal codes are integers:

  • 401 - app no longer exists
  • 402 - app is suspended
  • 403 - missing parameter
  • 404 - user account is suspended
  • 405 - invalid access token
  • 409 - app does not support phone two-factor verification
  • 412 - phone number already in use
  • 413 - app is migrated
  • 500 - internal server error
  • 602 - invalid data