Skip to main content

Set Custom Invite User Message Text

PUT 
https://$CUSTOM-DOMAIN/management/v1/text/message/invite_user/:language

Set the custom text of the invite user message/email for the organization. The message is sent when an invite code email is requested. The Following Variables can be used: {{.UserName}} {{.FirstName}} {{.LastName}} {{.NickName}} {{.DisplayName}} {{.LastEmail}} {{.VerifiedEmail}} {{.LastPhone}} {{.VerifiedPhone}} {{.PreferredLoginName}} {{.LoginNames}} {{.ChangeDate}} {{.CreationDate}} {{.ApplicationName}}

Request​

Path Parameters

    language stringrequired

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.

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: <= 500 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/management/v1/text/message/invite_user/:language' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "title": "Invitation to {{.ApplicationName}}",
  "preHeader": "Invitation to {{.ApplicationName}}",
  "subject": "Invitation to {{.ApplicationName}}",
  "greeting": "Hello {{.DisplayName}},",
  "text": "Your user has been invited to {{.ApplicationName}}. Please click the button below to finish the invite process. If you didn'\''t ask for this mail, please ignore it.",
  "buttonText": "Accept invite",
  "footerText": "string"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— header
Body required
{
  "title": "Invitation to {{.ApplicationName}}",
  "preHeader": "Invitation to {{.ApplicationName}}",
  "subject": "Invitation to {{.ApplicationName}}",
  "greeting": "Hello {{.DisplayName}},",
  "text": "Your user has been invited to {{.ApplicationName}}. Please click the button below to finish the invite process. If you didn't ask for this mail, please ignore it.",
  "buttonText": "Accept invite",
  "footerText": "string"
}
ResponseClear

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