Set contact phone​
Add or update the contact phone number of a user. If the phone is not passed as verified, a verification code will be generated, which can be either returned or will be sent to the user by SMS.
Path Parameters
unique identifier of the user.
Request Body required
phone object
Set the user's contact phone and it's verification state.
Possible values: non-empty
and <= 20 characters
Set the user's phone number.
Let ZITADEL send the link to the user via SMS.
Get the code back to provide it to the user in your preferred mechanism.
Set the phone as already verified.
Request Body required
phone object
Set the user's contact phone and it's verification state.
Possible values: non-empty
and <= 20 characters
Set the user's phone number.
Let ZITADEL send the link to the user via SMS.
Get the code back to provide it to the user in your preferred mechanism.
Set the phone as already verified.
Request Body required
phone object
Set the user's contact phone and it's verification state.
Possible values: non-empty
and <= 20 characters
Set the user's phone number.
Let ZITADEL send the link to the user via SMS.
Get the code back to provide it to the user in your preferred mechanism.
Set the phone as already verified.
- 200
- 403
- 404
- default
Contact phone successfully set
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
The phone verification code will be set if a contact phone was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.376Z",
"resourceOwner": "69629023906488334"
},
"emailCode": "SKJd342k"
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
The phone verification code will be set if a contact phone was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.376Z",
"resourceOwner": "69629023906488334"
},
"emailCode": "SKJd342k"
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
The phone verification code will be set if a contact phone was set with a return_code verification option.
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.376Z",
"resourceOwner": "69629023906488334"
},
"emailCode": "SKJd342k"
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}