Set own user phone number

Sets your phone number and country code. BOTH are required and they travel together: the identity provider validates the number against the country and refuses an unresolvable pair.

This is the self-service twin of the administrative PATCH /v1/users/{id}. An empty phone here is refused with 400 rather than clearing anything — clearing is DELETE /v1/users/{id}/phone.

Any authenticated member may call this for THEMSELVES; an {id} other than your token’s subject is refused with 403 IDE-0057.

On success the response has no body (204).

Failures:

• 400 — {id} is not a UUID, or the number/country pair is malformed or empty.
• 401 — no bearer token.
• 403 IDE-0057 — {id} is not you.
• 404 — no such user.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

PATCH /v1/users/{id}/phone

Set own user phone number

cURL

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/users/{id}/phone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "countryCode": "BR",
  "phone": "[phone]"
}
'

400

{
  "code": "<string>",
  "entityType": "<string>",
  "err": "<unknown>",
  "message": "<string>",
  "title": "<string>"
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Caller's own User ID.

Example:

"00000000-0000-0000-0000-000000000000"

Body

application/json

The phone number and country code, which travel together.

countryCode · string · required

Example:

"BR"

phone · string · required

Example:

"[phone]"

Response

204

No Content