Skip to main content

Set Custom Password Reset Message Text​

Set the custom text of the password reset user message/email for the organization. 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
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.

Request Body required
    title string

    Possible values: <= 500 characters

    preHeader string

    Possible values: <= 500 characters

    subject string

    Possible values: <= 500 characters

    greeting string

    Possible values: <= 1000 characters

    text string

    Possible values: <= 10000 characters

    buttonText string

    Possible values: <= 1000 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

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/management/v1
Bearer Token
language — path required
x-zitadel-orgid — header
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 / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/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"
}'