Skip to main content

Set Custom Init Message Text​

Set the custom text of the initialize-user message/email the default texts will be overwritten for the organization. The email is sent when a user is created and has either no password or a non-verified email address. 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: <= 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/init/:language

Authorization

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

Request

Base URL
https://$ZITADEL_DOMAIN/management/v1
Bearer Token
language — path required
x-zitadel-orgid — header
Content-Type
Body required
{

  "title": "ZITADEL - Initialize User",

  "preHeader": "Initialize User",

  "subject": "Initialize User",

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

  "text": "This user was created in Zitadel. Use the username {{.PreferredLoginName}} to log in. Please click the button below to finish the initialization process. (Code {{.Code}}) If you didn't ask for this mail, please ignore it.",

  "buttonText": "Finish initialization",

  "footerText": "string"

}
Accept
curl -L -X PUT 'https://$ZITADEL_DOMAIN/management/v1/text/message/init/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "title": "ZITADEL - Initialize User",
  "preHeader": "Initialize User",
  "subject": "Initialize User",
  "greeting": "Hello {{.FirstName}} {{.LastName}},",
  "text": "This user was created in Zitadel. Use the username {{.PreferredLoginName}} to log in. Please click the button below to finish the initialization process. (Code {{.Code}}) If you didn'\''t ask for this mail, please ignore it.",
  "buttonText": "Finish initialization",
  "footerText": "string"
}'