Curated Email Automation

Description

A curated automated email message that should be sent to a specified group of recipients at a configured time.

Properties

Property Description
copyStudioOnEmail

Send a copy of this email message to the studio at the same time it is sent to the recipients.

created read-only

The date on which the entity was created.

emailTemplateId

The identifier for the email template to use with this email automation.

id

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

name

The name for this curated email automation.

recipientType

Who to send this automation email message to.

API validation of the recipientType is based on the resourceType of the email template specified by emailTemplateId. Refer to the following table for details on which values are acceptable for recipientType and under which conditions they are acceptable.

ShootProof Identifier For Email Templates With Resource Type Description
event-visitors-all event Send this email to all event visitors.
event-visitors-with-cart-items event Send this email to event visitors who have items in their carts.
event-visitors-with-favorites event Send this email to event visitors who have favorited items in the event.
event-visitors-with-orders event Send this email to event visitors who have placed an order.
event-visitors-without-orders event Send this email to event visitors who have not placed and order.
invoice-contact invoice Send this email to the contact(s) listed for the invoice.
sendType

When to send this automated email message.

API validation of the sendType is based on the resourceType of the email template specified by emailTemplateId. Refer to the following table for details on which values are acceptable for sendType and under which conditions they are acceptable.

ShootProof Identifier For Email Templates With Resource Type Description
days-after-event-expiration-date event Send this email sendTypeValue number of days after the event expiration date.
days-after-event-release-date event Send this email sendTypeValue number of days after the event release date.
days-after-event-shoot-date event Send this email sendTypeValue number of days after the event shoot date.
days-after-final-payment-due invoice Send this email sendTypeValue number of days after the final payment is due.
days-after-order-due-date event Send this email sendTypeValue number of days after the order due date.
days-before-event-expiration-date event Send this email sendTypeValue number of days before the event expiration date.
days-before-final-payment-due invoice Send this email sendTypeValue number of days before the final payment is due.
days-before-order-due-date event Send this email sendTypeValue number of days before the order due date.
sendTypeValue

Specifies the number of units (e.g., days, hours, etc.) to use for the selected sendType.

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 message that should be sent to a specified group of\nrecipients at a configured time.",
  "properties": {
    "copyStudioOnEmail": {
      "description": "Send a copy of this email message to the studio at the same time it is\nsent to the recipients.",
      "type": "boolean"
    },
    "created": {
      "$ref": "#/components/schemas/Signature/properties/created"
    },
    "emailTemplateId": {
      "allOf": [
        {
          "description": "The identifier for the email template to use with this email automation.",
          "example": "b1c6d4d5-552e-47d2-8e3c-6c69bd73a338"
        },
        {
          "$ref": "#/components/schemas/Id"
        }
      ]
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "name": {
      "description": "The name for this curated email automation.",
      "example": "Gallery Expiring in 7 Days",
      "type": "string"
    },
    "recipientType": {
      "description": "Who to send this automation email message to.\n\nAPI validation of the `recipientType` is based on the `resourceType` of\nthe email template specified by `emailTemplateId`. Refer to the following\ntable for details on which values are acceptable for `recipientType` and\nunder which conditions they are acceptable.\n\n| ShootProof Identifier | For Email Templates With Resource Type | Description |\n| --------------------- | -------------------------------------- | ----------- |\n| `event-visitors-all` | `event` | Send this email to all event visitors. |\n| `event-visitors-with-cart-items` | `event` | Send this email to event visitors who have items in their carts. |\n| `event-visitors-with-favorites` | `event` | Send this email to event visitors who have favorited items in the event. |\n| `event-visitors-with-orders` | `event` | Send this email to event visitors who **have** placed an order. |\n| `event-visitors-without-orders` | `event` | Send this email to event visitors who **have not** placed and order. |\n| `invoice-contact` | `invoice` | Send this email to the contact(s) listed for the invoice. |",
      "enum": [
        "event-visitors-all",
        "event-visitors-with-cart-items",
        "event-visitors-with-favorites",
        "event-visitors-with-orders",
        "event-visitors-without-orders",
        "invoice-contact"
      ],
      "type": "string"
    },
    "sendType": {
      "description": "When to send this automated email message.\n\nAPI validation of the `sendType` is based on the `resourceType` of the\nemail template specified by `emailTemplateId`. Refer to the following\ntable for details on which values are acceptable for `sendType` and under\nwhich conditions they are acceptable.\n\n| ShootProof Identifier | For Email Templates With Resource Type | Description |\n| --------------------- | -------------------------------------- | ----------- |\n| `days-after-event-expiration-date` | `event` | Send this email `sendTypeValue` number of days after the event expiration date. |\n| `days-after-event-release-date` | `event` | Send this email `sendTypeValue` number of days after the event release date. |\n| `days-after-event-shoot-date` | `event` | Send this email `sendTypeValue` number of days after the event shoot date. |\n| `days-after-final-payment-due` | `invoice` | Send this email `sendTypeValue` number of days after the final payment is due. |\n| `days-after-order-due-date`| `event` | Send this email `sendTypeValue` number of days after the order due date. |\n| `days-before-event-expiration-date` | `event` | Send this email `sendTypeValue` number of days before the event expiration date. |\n| `days-before-final-payment-due` | `invoice` | Send this email `sendTypeValue` number of days before the final payment is due. |\n| `days-before-order-due-date` | `event` | Send this email `sendTypeValue` number of days before the order due date. |",
      "enum": [
        "days-after-event-expiration-date",
        "days-after-event-release-date",
        "days-after-event-shoot-date",
        "days-after-final-payment-due",
        "days-after-order-due-date",
        "days-before-event-expiration-date",
        "days-before-final-payment-due",
        "days-before-order-due-date"
      ],
      "type": "string"
    },
    "sendTypeValue": {
      "description": "Specifies the number of units (e.g., days, hours, etc.) to use for the\nselected `sendType`.",
      "type": "integer"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "curated-email-automation"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "emailTemplateId",
    "sendType",
    "sendTypeValue",
    "recipientType"
  ],
  "title": "Curated Email Automation",
  "type": "object"
}