Skip to main content

Set Default Domain Claimed Message Text​

Set the custom text of the domain claimed 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 message/email is sent when an organization claims a domain and a user of this domain exists in another organization. The Following Variables can be used: {{.Domain}} {{.TempUsername}} {{.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/domainclaimed/: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 - Domain has been claimed",

  "preHeader": "Change email / username",

  "subject": "Domain has been claimed",

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

  "text": "The domain {{.Domain}} has been claimed by an organization. Your current user {{.UserName}} is not part of this organization. Therefore you'll have to change your email when you log in. We have created a temporary username ({{.TempUsername}}) for this login.",

  "buttonText": "Login",

  "footerText": "string"

}
Accept
curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/text/message/domainclaimed/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "title": "ZITADEL - Domain has been claimed",
  "preHeader": "Change email / username",
  "subject": "Domain has been claimed",
  "greeting": "Hello {{.FirstName}} {{.LastName}},",
  "text": "The domain {{.Domain}} has been claimed by an organization. Your current user {{.UserName}} is not part of this organization. Therefore you'\''ll have to change your email when you log in. We have created a temporary username ({{.TempUsername}}) for this login.",
  "buttonText": "Login",
  "footerText": "string"
}'