Curated Email Template : Studio API : Reference : ShootProof for Developers

Description

curated-email-template

Curated Email Template

A curated automated email template containing the email information to be sent as part of an automated email campaign.

Properties

Property	Description
body	`string` The primary content that will be displayed in the body of the email.
buttonText	`string` The text to appear on a call to action which appears in the email.
created read-only	`string` date-time Signature The date on which the entity was created.
emailCategory	`string` enum wedding portrait newborn corporate senior holiday The human-readable name of the category of this automation.
headline	`string` A headline that appears as part of the email body.
id	either `string` uuid UUID Entity Identifier or `integer` Integer Entity Identifier An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only	`object` Links 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	`string` The name for this curated email template.
resourceType	`string` enum event event-album mobile-app invoice order contract The type of resource associated with the email template.
subject	`string` The subject line of the email sent to a user.
type	`string` enum curated-email-template 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 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"
}

Curated Email Template