Set Custom Verify Phone Reset Message Text
Set the custom text of the verify-phone message for the organization. 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}}
Path Parameters
- language string required
Header Parameters
- x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- title string
Possible values:
<= 200 characters
- preHeader string
Possible values:
<= 200 characters
- subject string
Possible values:
<= 200 characters
- greeting string
Possible values:
<= 200 characters
- text string
Possible values:
<= 800 characters
- buttonText string
Possible values:
<= 200 characters
- footerText string
Request Body required
- title string
Possible values:
<= 200 characters
- preHeader string
Possible values:
<= 200 characters
- subject string
Possible values:
<= 200 characters
- greeting string
Possible values:
<= 200 characters
- text string
Possible values:
<= 800 characters
- buttonText string
Possible values:
<= 200 characters
- footerText string
Request Body required
- title string
Possible values:
<= 200 characters
- preHeader string
Possible values:
<= 200 characters
- subject string
Possible values:
<= 200 characters
- greeting string
Possible values:
<= 200 characters
- text string
Possible values:
<= 800 characters
- buttonText string
Possible values:
<= 200 characters
- footerText string
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
- Schema
- Example (from schema)
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2023-05-12",
"changeDate": "2023-05-12",
"resourceOwner": "69629023906488334"
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
PUT /text/message/verifyphone/:language
Authorization
type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud
Request
Request
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/text/message/verifyphone/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"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"
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/text/message/verifyphone/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"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"
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/text/message/verifyphone/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"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"
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/text/message/verifyphone/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"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"
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/text/message/verifyphone/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"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"
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/text/message/verifyphone/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"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"
}'
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/text/message/verifyphone/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"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"
}'