Skip to main content

Set Default Custom Init Message Text

PUT 
https://$CUSTOM-DOMAIN/admin/v1/text/message/init/:language

Set the custom text of the initialize-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 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}}

Request​

Path Parameters

    language stringrequired

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 (string)
curl -L -X PUT 'https://$CUSTOM-DOMAIN/admin/v1/text/message/init/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "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"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Parameters
— pathrequired
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"
}
ResponseClear

Click the Send API Request button above and see the response here!