ZITADEL Docs
APIsCore ResourcesV1Organization Objects

UpdateHumanPhone

Update User Phone (Human)

Deprecated: use user service v2 UpdateUser instead.

Change the phone number of a user. If the state is set to not verified, the user will get an SMS to verify (if a notification provider is configured). The phone number is only for informational purposes and to send messages, not for Authentication (2FA).

PUT
/users/{user_id}/phone

Path Parameters

user_id*string

Request Body

application/json

phone*string
isPhoneVerified?boolean
[key: string]?never

Response Body

application/json

application/json

curl -X PUT "https://loading/users/string/phone" \  -H "Content-Type: application/json" \  -d '{    "phone": "string"  }'
{
  "details": {
    "sequence": 0,
    "creationDate": "1s",
    "changeDate": "1s",
    "resourceOwner": "string"
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?