Property description

The property description is an optional property that can be used to attach a human readable description to the template. The description does not have any influence on the generated HTML code, and it will not appear inside the email.


The following input JSON contains a very simple example template the top two properties are its name and description. Both the name and description properties are meta properties that are not used by the API to generate the email, but that may be helpful to identify and/or describe the template.

  "name": "Name of the template",
  "description": "Description of the template",
  "from": "",
  "subject": "Example email",
  "background": {
    "color": "#f3f3f3"
    "content": {
      "blocks": [{
        "type": "text",
        "content": "This is an example email"
        }, {
          "type": "image",
          "src": ""

The property description can be used to set a human readable description in the template. Both the name and the description are top level properties.

Found a typo?

You can find this documentation page on GitHub.
Propose a change