An email message to a client about their event.
Property | Description |
---|---|
body |
The message to include in the body of the email. |
buttonText |
The text for the call-to-action button in the email body. |
emailRecipientType |
An optional email recipient type, which retrieves recipients from the event's visitors. Valid values are strings, which map to the following types:
Note that for certain event-related emails, both |
headline |
The headline to use in the email body. |
recipientEmails |
Email address(es) to send the email to. Required for email types that can be sent to arbitrary recipients. Must be an array of valid email addresses when required. When sending an event email to one or more arbitrary recipients, a studio-level limit on the number of email recipients is enforced. These are returned as validation errors on the Similarly, a rate limit is enforced and returned on the For emails always intended for the event contact, at least the event contact's email address must be provided in the array. If it is not provided, a validation error will be present on the Note that for certain event-related emails, both |
subject |
The subject line for the email message. |
type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "An email message to a client about their event.",
"properties": {
"body": {
"description": "The message to include in the body of the email.",
"maxLength": 10000,
"type": "string"
},
"buttonText": {
"description": "The text for the call-to-action button in the email body.",
"maxLength": 25,
"type": "string"
},
"emailRecipientType": {
"description": "An optional email recipient type, which retrieves recipients\nfrom the event's visitors.\n\nValid values are strings, which map to the following types:\n\n* `all-event-visitors`: All visitors to this gallery\n* `event-visitors-with-favorites`: Visitors with favorites\n* `event-visitors-with-cart-items`: Visitors with items in their\ncart\n* `event-visitors-with-orders`: Visitors who HAVE placed an\norder\n* `event-visitors-without-orders`: Visitors who HAVE NOT placed\nan order\n\nNote that for certain event-related emails, both\n`recipientEmails` and the emails retrieved for the given\n`emailRecipientType` value will be combined to send the email to\nmany recipients.",
"enum": [
"all-event-visitors",
"event-visitors-with-favorites",
"event-visitors-with-cart-items",
"event-visitors-with-orders",
"event-visitors-without-orders"
],
"type": "number"
},
"headline": {
"description": "The headline to use in the email body.",
"maxLength": 100,
"type": "string"
},
"recipientEmails": {
"description": "Email address(es) to send the email to.\n\nRequired for email types that can be sent to arbitrary\nrecipients. Must be an array of valid email addresses when\nrequired.\n\nWhen sending an event email to one or more arbitrary recipients,\na studio-level limit on the number of email recipients is\nenforced. These are returned as validation errors on the\n`recipientEmails` element..\n\nSimilarly, a rate limit is enforced and returned on the\n`recipientEmails` element as well.\n\nFor emails always intended for the event contact, at least the\nevent contact's email address must be provided in the array. If\nit is not provided, a validation error will be present on the\n`recipientEmails` element.\n\nNote that for certain event-related emails, both\n`recipientEmails` and the emails retrieved for the given\n`emailRecipientType` value will be combined to send the email to\nmany recipients.",
"items": {
"type": "string"
},
"type": "array"
},
"subject": {
"description": "The subject line for the email message.",
"maxLength": 200,
"type": "string"
},
"type": {
"allOf": [
{
"enum": [
"email"
]
},
{
"$ref": "#/components/schemas/Type"
}
]
}
},
"required": [
"type",
"subject",
"body"
],
"title": "Event Email",
"type": "object"
}