Get Default Verify SMS OTP Message Text​
Get the default text of the verify Email OTP message that is stored as translation files in ZITADEL itself. The text will be sent to the users of all organizations, that do not have a custom text configured. The message is sent when an SMS One-time password should be verified and a notification provider is configured.
Path Parameters
- 200
- 403
- 404
- default
A successful response.
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-06-13T06:44:39.129Z",
"changeDate": "2024-06-13T06:44:39.129Z",
"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
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-06-13T06:44:39.129Z",
"changeDate": "2024-06-13T06:44:39.129Z",
"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
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-06-13T06:44:39.130Z",
"changeDate": "2024-06-13T06:44:39.130Z",
"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
}
}
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"
}
]
}