Skip to main content

Set Default Custom Password Reset Message Text​

Set the custom text of the password reset user 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. 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
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
Responses

A successful response.

Schema
  • details object
  • sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

  • creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
PUT /text/message/passwordreset/:language

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/admin/v1
Bearer Token
language — path required
Content-Type
Body required
{

  "title": "ZITADEL - Reset Password",

  "preHeader": "Reset Password",

  "subject": "Reset Password",

  "greeting": "Hello {{.FirstName}} {{.LastName}},",

  "text": "We received a password reset request. Please use the button below to reset your password. (Code {{.Code}}) If you didn't ask for this mail, please ignore it.",

  "buttonText": "Reset Password",

  "footerText": "string"

}
Accept
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/text/message/passwordreset/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "title": "ZITADEL - Reset Password",
  "preHeader": "Reset Password",
  "subject": "Reset Password",
  "greeting": "Hello {{.FirstName}} {{.LastName}},",
  "text": "We received a password reset request. Please use the button below to reset your password. (Code {{.Code}}) If you didn'\''t ask for this mail, please ignore it.",
  "buttonText": "Reset Password",
  "footerText": "string"
}'