Email Template Collection

Description

A collection (or list) of resources.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
body

The user-entered body content of the email message, in HTML format.

buttonText

If a call-to-action button is displayed in the email, this is the text label that will appear on the button.

created read-only

The date on which the entity was created.

emailTemplateType

The constant ShootProof identifier for the email template type.

ShootProof Identifier Description
contract-ready Describes an email template that may be sent to a studio's client when a contract is ready to view.
documents-ready Describes an email template that may be sent to a studio's client when they have documents (i.e., invoice and contract) ready to view.
email-admin-access-url-to-linked-contact Describes an email template that may be used to give a linked contact access to an event while it's in pre-release.
email-event-album-link Describes an email template that may be used to share a specific album within an event.
email-event-link Describes an email template that may be used to share an event.
email-mobile-app-link Describes an email template that may be used to share a link to a mobile app with a studio's client.
event-expiring-notice Describes an email template that may be used to notify event visitors of an upcoming event expiration.
event-released-to-linked-contact Describes an email template that may be used to notify an event's linked contact that an event is now active.
event-released-to-visitors Describes an email template that may be used to notify event visitors that an event is now active.
event-upload-complete Describes an email template that may be used as an internal notification to the studio user that an upload is complete in their ShootProof account.
event-visitor-message Describes an email template that may be used to send general messages to event visitors.
invoice-final-payment-due-remainder Describes an email template that may be used to notify a studio's client that their final invoice payment will be due soon.
invoice-message Describes an email template that may be used to send general messages about an invoice to a studio's client.
invoice-past-due-notice Describes an email template that may be used to notify a studio's client that their invoice is past due.
invoice-ready Describes an email template that may be sent to a studio's client when an invoice is ready to view.
order-status-notice Describes an email template that may be sent to a studio's client when the status of their order changes.
headline

If a headline is displayed in the email, this is the text of that headline.

htmlEmail read-only

The full HTML email template, complete with in-lined CSS, headers, and footers. This may be used to render a representation of the email message, allowing the studio user an opportunity to preview their message before sending it.

htmlEmailCss read-only

CSS styles that may be used to style a representation of the email message, providing the studio user an opportunity to preview their message before sending it.

id

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

name

The name of this email template.

resourceType nullable read-only

If present, this describes the type of resource represented by this email template.

subject

The email subject line to use for this template.

type

The type of object represented.

links required read-only

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

type

The type of resource represented.

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"
}