API Docs / Schemas / EmailBroadcastPreviewDto

EmailBroadcastPreviewDto

Preview of a broadcast email rendered for a specific sample client, with resolved recipients.
Returned before sending so the user can review what will be sent.

Properties

Name Type Description
subjectstring

Rendered subject line with Liquid tokens resolved for the sample client.

Rendered subject line with Liquid tokens resolved for the sample client.

bodyHtmlstring

Rendered body HTML with header/footer/theme applied and Liquid tokens resolved for the sample client.

Rendered body HTML with header/footer/theme applied and Liquid tokens resolved for the sample client.

toRecipientsarray of EmailPreviewRecipientDto

Resolved To recipients for the sample client.

Resolved To recipients for the sample client.

ccRecipientsarray of EmailPreviewRecipientDto

Resolved CC recipients for the sample client.

Resolved CC recipients for the sample client.

bccRecipientsarray of EmailPreviewRecipientDto

Resolved BCC recipients for the sample client.

Resolved BCC recipients for the sample client.

JSON Example

{
  "subject": "string",
  "bodyHtml": "string",
  "toRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ],
  "ccRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ],
  "bccRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ]
}

Used By Operations