Get Custom Domain Claimed Message Text

Get 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 is sent when an organization claims a domain and a user of this domain exists in another organization.

Path Parameters

• language string required

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

Schema

• customText object

  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

  title string

  custom text for email title

  preHeader string

  custom text for email pre-header

  subject string

  custom text for email subject

  greeting string

  custom text for email greeting

  text string

  custom text for email text

  buttonText string

  custom text for email button_text

  footerText string

  custom text for email footer_text

  isDefault boolean

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "resourceOwner": "69629023906488334"
    },
    "title": "ZITADEL - Message Title",
    "preHeader": "User Message",
    "subject": "Message Subject",
    "greeting": "Hello {{.FirstName}} {{.LastName}},",
    "text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
    "buttonText": "Call to action",
    "footerText": "",
    "isDefault": true
  }
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• customText object

  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

  title string

  custom text for email title

  preHeader string

  custom text for email pre-header

  subject string

  custom text for email subject

  greeting string

  custom text for email greeting

  text string

  custom text for email text

  buttonText string

  custom text for email button_text

  footerText string

  custom text for email footer_text

  isDefault boolean

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "resourceOwner": "69629023906488334"
    },
    "title": "ZITADEL - Message Title",
    "preHeader": "User Message",
    "subject": "Message Subject",
    "greeting": "Hello {{.FirstName}} {{.LastName}},",
    "text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
    "buttonText": "Call to action",
    "footerText": "",
    "isDefault": true
  }
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• customText object

  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

  title string

  custom text for email title

  preHeader string

  custom text for email pre-header

  subject string

  custom text for email subject

  greeting string

  custom text for email greeting

  text string

  custom text for email text

  buttonText string

  custom text for email button_text

  footerText string

  custom text for email footer_text

  isDefault boolean

{
  "customText": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-02",
      "changeDate": "2023-05-02",
      "resourceOwner": "69629023906488334"
    },
    "title": "ZITADEL - Message Title",
    "preHeader": "User Message",
    "subject": "Message Subject",
    "greeting": "Hello {{.FirstName}} {{.LastName}},",
    "text": "This is my custom message Text. I can also include some fields, depending on the message type I want to send. {{.FirstName}} {{.LastName}},",
    "buttonText": "Call to action",
    "footerText": "",
    "isDefault": true
  }
}

Returned when the user does not have permission to access the resource.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

GET /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

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/text/message/domainclaimed/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/text/message/domainclaimed/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/text/message/domainclaimed/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/text/message/domainclaimed/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/text/message/domainclaimed/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/text/message/domainclaimed/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/admin/v1/text/message/domainclaimed/:language' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'