Email Automation Group

Description

Properties

Property Description
automations

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

clonedFromId nullable

If cloned from another automation group, the identifier for the group from which this was cloned.

created read-only

The date on which the entity was created.

id

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

isClonedFromSpAutomationGroup read-only

If this automation group was cloned from a ShootProof-created email automation group, then this property will be true.

linkedEventsCount read-only

The total number of non-deleted events that are using the automation group.

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 for this email automation group.

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.

{
  "properties": {
    "automations": {
      "description": "A collection of automated email messages that should be sent to a\nspecified group of recipients at a configured time.",
      "items": {
        "$ref": "#/components/schemas/EmailAutomation"
      },
      "title": "Email Automations",
      "type": "array"
    },
    "clonedFromId": {
      "allOf": [
        {
          "description": "If cloned from another automation group, the identifier for the group\nfrom which this was cloned.",
          "example": "b1c6d4d5-552e-47d2-8e3c-6c69bd73a338",
          "nullable": true
        },
        {
          "$ref": "#/components/schemas/Id"
        }
      ]
    },
    "created": {
      "$ref": "#/components/schemas/Signature/properties/created"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "isClonedFromSpAutomationGroup": {
      "description": "If this automation group was cloned from a ShootProof-created email\nautomation group, then this property will be `true`.",
      "readOnly": true,
      "type": "boolean"
    },
    "linkedEventsCount": {
      "description": "The total number of non-deleted events that are using the automation\ngroup.",
      "readOnly": true,
      "type": "integer"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name for this email automation group.",
      "example": "My Wedding Automation",
      "maxLength": 250,
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "email-automation-group"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "name"
  ],
  "title": "Email Automation Group",
  "type": "object"
}