Email Template Collection

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "properties": {
          "body": {
            "description": "The user-entered body content of the email message, in HTML format.",
            "type": "string"
          },
          "buttonText": {
            "description": "If a call-to-action button is displayed in the email, this is the text\nlabel that will appear on the button.",
            "type": "string"
          },
          "created": {
            "$ref": "#/components/schemas/Signature/properties/created"
          },
          "emailTemplateType": {
            "$ref": "#/components/schemas/EmailTemplateType/properties/emailTemplateType"
          },
          "headline": {
            "description": "If a headline is displayed in the email, this is the text of that\nheadline.",
            "type": "string"
          },
          "htmlEmail": {
            "description": "The full HTML email template, complete with in-lined CSS, headers,\nand footers. This may be used to render a representation of the email\nmessage, allowing the studio user an opportunity to preview their\nmessage before sending it.",
            "readOnly": true,
            "type": "string"
          },
          "htmlEmailCss": {
            "description": "CSS styles that may be used to style a representation of the email\nmessage, providing the studio user an opportunity to preview their\nmessage before sending it.",
            "readOnly": true,
            "type": "string"
          },
          "id": {
            "$ref": "#/components/schemas/Id"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "The name of this email template.",
            "type": "string"
          },
          "resourceType": {
            "allOf": [
              {
                "readOnly": true
              },
              {
                "$ref": "#/components/schemas/EmailTemplateType/properties/resourceType"
              }
            ]
          },
          "subject": {
            "description": "The email subject line to use for this template.",
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "email-template"
            ],
            "type": "string"
          }
        },
        "title": "Email Template",
        "type": "object"
      },
      "title": "Email Template",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "email-template-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "A collection of email templates",
  "type": "object"
}