PhoneChange

[POST] .../v1/user/phonechange

Request to change a user phone number Use this identity workflow only when the phone-change endpoints are enabled for the account. The method validates id and phone, checks the current request user's user edit permission, creates a phone-change confirmation request through the persistent layer and returns ok=true when the request is accepted. The request body is required, id must be non-zero, phone must be provided and the endpoint immediately returns the configured disabled ErrorResult when identity endpoint setting is turned off. Missing fields, denied permission, disabled identity endpoints, confirmation-delivery errors and persistent failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id Int64 Required User ID.
phone String Required New user phone number.

Request Example

{
  "id": 17,
  "phone": "\u002B998901112233"
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Object Request result.

Response Example

{
  "ok": true
}