Curated 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": {
        "description": "A curated automated email template containing the email information to be sent\nas part of an automated email campaign.",
        "properties": {
          "body": {
            "description": "The primary content that will be displayed in the body of the email.",
            "example": "<p>You deserve a break from your to-do list. Take ten and view your photographs!</p>\\n<p>((gallery.name))</p>",
            "type": "string"
          },
          "buttonText": {
            "description": "The text to appear on a call to action which appears in the email.",
            "example": "VIEW PHOTOS",
            "type": "string"
          },
          "created": {
            "$ref": "#/components/schemas/Signature/properties/created"
          },
          "emailCategory": {
            "description": "The human-readable name of the category of this automation.",
            "enum": [
              "wedding",
              "portrait",
              "newborn",
              "corporate",
              "senior",
              "holiday"
            ],
            "type": "string"
          },
          "headline": {
            "description": "A headline that appears as part of the email body.",
            "example": "Take Time for a Photo Break",
            "type": "string"
          },
          "id": {
            "$ref": "#/components/schemas/Id"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "The name for this curated email template.",
            "example": "ShootProof Corporate 6-Week Reminder",
            "type": "string"
          },
          "resourceType": {
            "description": "The type of resource associated with the email template.",
            "enum": [
              "event",
              "event-album",
              "mobile-app",
              "invoice",
              "order",
              "contract"
            ],
            "type": "string"
          },
          "subject": {
            "description": "The subject line of the email sent to a user.",
            "example": "A full gallery of photographs is ready for you!",
            "type": "string"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Type"
              },
              {
                "enum": [
                  "curated-email-template"
                ]
              }
            ]
          }
        },
        "required": [
          "type"
        ],
        "title": "Curated Email Template",
        "type": "object"
      },
      "title": "Curated 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": [
        "curated-email-template-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Curated Email Templates",
  "type": "object"
}