POST api/users/{guid}/phone

Update (Or register) a phone number, sending the user a verification SMS with a code

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

globally unique identifier

Required

Body Parameters

PostPhoneReq
NameDescriptionTypeAdditional information
PhoneNumber

The user's phone number. Fairly flexible on terms of format

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "phoneNumber": "sample string 1"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Update (Or register) a phone number, sending the user a verification SMS with a code

PostPhoneResp
NameDescriptionTypeAdditional information
VerificationMessageSent

Whether the verification SMS was successfully sent. Will only be false in the case of an error updating/inserting the number, or an error in sending the SMS. In either case, resending the request is unlikely to help.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "verificationMessageSent": true
}

Error responses

  • invalid_fields - The submitted information is incomplete or otherwise invalid. The description of the error will be a detailed summary of invalid fields