Set Default Verify Phone Reset Message Text
PUThttps://$CUSTOM-DOMAIN/admin/v1/text/message/verifyphone/:language
Set the custom text of the verify-phone user message that is overwritten on the instance as settings/database. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when a user adds a new non-verified phone number and a notification provider is configured. The Following Variables can be used: {{.Code}} {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}}
Request​
Path Parameters
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
Possible values: <= 500 characters
Possible values: <= 500 characters
Possible values: <= 500 characters
Possible values: <= 1000 characters
Possible values: <= 800 characters
Possible values: <= 1000 characters
Body
required
Possible values: <= 500 characters
Possible values: <= 500 characters
Possible values: <= 500 characters
Possible values: <= 1000 characters
Possible values: <= 800 characters
Possible values: <= 1000 characters
Body
required
Possible values: <= 500 characters
Possible values: <= 500 characters
Possible values: <= 500 characters
Possible values: <= 1000 characters
Possible values: <= 800 characters
Possible values: <= 1000 characters
Responses​
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
{
"details": {
"sequence": "2",
"creationDate": "2025-03-31T10:57:53.240Z",
"changeDate": "2025-03-31T10:57:53.240Z",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details
object
{
"details": {
"sequence": "2",
"creationDate": "2025-03-31T10:57:53.240Z",
"changeDate": "2025-03-31T10:57:53.240Z",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details
object
{
"details": {
"sequence": "2",
"creationDate": "2025-03-31T10:57:53.240Z",
"changeDate": "2025-03-31T10:57:53.240Z",
"resourceOwner": "69629023906488334"
}
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/text/message/verifyphone/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"title": "ZITADEL - Verify Phone",
"preHeader": "Verify Phone",
"subject": "Verify Phone",
"greeting": "Hello {{.FirstName}} {{.LastName}},",
"text": "A new phone number has been added. Please use the following code to verify it {{.Code}}.",
"buttonText": "Verify Phone",
"footerText": "string"
}'