Get Default Verify Email Message Text
GET/text/default/message/verifyemail/:language
Get the default text of the verify-email message/email that is set on the instance or as translation files in ZITADEL itself. The email is sent when a user adds a new non-verified email address.
Request​
Path Parameters
Header Parameters
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.
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
customText
object
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 first event of the object
on create: 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
custom text for email title
custom text for email pre-header
custom text for email subject
custom text for email greeting
custom text for email text
custom text for email button_text
custom text for email footer_text
{
"customText": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.601Z",
"changeDate": "2024-11-15T21:46:16.601Z",
"resourceOwner": "69629023906488334"
},
"title": "ZITADEL - Message Title",
"preHeader": "User Message",
"subject": "Message Subject",
"greeting": "Hello {{.FirstName}} {{.LastName}},",
"text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
"buttonText": "Call to action",
"footerText": "",
"isDefault": true
}
}
- Schema
- Example (from schema)
Schema
customText
object
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 first event of the object
on create: 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
custom text for email title
custom text for email pre-header
custom text for email subject
custom text for email greeting
custom text for email text
custom text for email button_text
custom text for email footer_text
{
"customText": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.601Z",
"changeDate": "2024-11-15T21:46:16.601Z",
"resourceOwner": "69629023906488334"
},
"title": "ZITADEL - Message Title",
"preHeader": "User Message",
"subject": "Message Subject",
"greeting": "Hello {{.FirstName}} {{.LastName}},",
"text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
"buttonText": "Call to action",
"footerText": "",
"isDefault": true
}
}
- Schema
- Example (from schema)
Schema
customText
object
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 first event of the object
on create: 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
custom text for email title
custom text for email pre-header
custom text for email subject
custom text for email greeting
custom text for email text
custom text for email button_text
custom text for email footer_text
{
"customText": {
"details": {
"sequence": "2",
"creationDate": "2024-11-15T21:46:16.602Z",
"changeDate": "2024-11-15T21:46:16.602Z",
"resourceOwner": "69629023906488334"
},
"title": "ZITADEL - Message Title",
"preHeader": "User Message",
"subject": "Message Subject",
"greeting": "Hello {{.FirstName}} {{.LastName}},",
"text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
"buttonText": "Call to action",
"footerText": "",
"isDefault": true
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}