Skip to main content

Set the user phone

POST 
https://$CUSTOM-DOMAIN/v2/users/:userId/phone

Set the phone number of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by sms..

Request​

Path Parameters

    userId stringrequired

Body

required

    phone stringrequired

    Possible values: non-empty and <= 200 characters

    sendCode object
    returnCode object
    isVerified boolean

Responses​

OK

Schema

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to (string)
    creationDate date-time
    verificationCode in case the verification was set to return_code, the code will be returned (string)
curl -L 'https://$CUSTOM-DOMAIN/v2/users/:userId/phone' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "phone": "+41791234567",
  "sendCode": {},
  "returnCode": {},
  "isVerified": true
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN
Auth
Parameters
— pathrequired
Body required
{
  "phone": "+41791234567",
  "sendCode": {},
  "returnCode": {},
  "isVerified": true
}
ResponseClear

Click the Send API Request button above and see the response here!