Email Automation Group 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": {
        "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"
      },
      "title": "Email Automation Group",
      "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-automation-group-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Email Automation Groups",
  "type": "object"
}