A curated automated email group created internally to assist studios in creating their own email automations. These resources can only be read from the API.
Property | Description |
---|---|
automations |
A collection of automated email messages that should be sent to a specified group of recipients at a configured time. |
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. |
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. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A curated automated email group created internally to assist studios in creating their own email automations.\nThese resources can only be read from the API.",
"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/CuratedEmailAutomation"
},
"title": "Email Automations",
"type": "array"
},
"created": {
"$ref": "#/components/schemas/Signature/properties/created"
},
"id": {
"$ref": "#/components/schemas/Id"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The name for this email automation group.",
"example": "My Wedding Automation",
"type": "string"
},
"type": {
"allOf": [
{
"$ref": "#/components/schemas/Type"
},
{
"enum": [
"curated-email-automation-group"
]
}
]
}
},
"required": [
"type",
"name"
],
"title": "Curated Email Automation Group",
"type": "object"
}