Get Custom Password Reset Message Text
GET/text/message/passwordreset/:language
Get the custom text of the password reset message/email 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 email is sent when a user triggers the password forgot-request.
Request​
Path Parameters
Responses​
- 200
- 403
- 404
- 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-22T09:27:14.520Z",
"changeDate": "2024-11-22T09:27:14.520Z",
"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-22T09:27:14.520Z",
"changeDate": "2024-11-22T09:27:14.520Z",
"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-22T09:27:14.521Z",
"changeDate": "2024-11-22T09:27:14.521Z",
"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.
- 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"
}
]
}
Returned when the resource does not exist.
- 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"
}
]
}
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"
}
]
}