EmailBroadcastRecipientDto

A single client within an email broadcast with its resolved recipients and delivery status.
Before send this is a live pre-send resolution; after send it reflects the stored snapshot.

Properties

Name	Type	Description
clientCode	string	The client's code
The client's code
clientName	string	The client's name
The client's name
toRecipients	array of EmailPreviewRecipientDto	Resolved To recipients for this client's email.
Resolved To recipients for this client's email.
ccRecipients	array of EmailPreviewRecipientDto	Resolved CC recipients for this client's email.
Resolved CC recipients for this client's email.
bccRecipients	array of EmailPreviewRecipientDto	Resolved BCC recipients for this client's email.
Resolved BCC recipients for this client's email.
status	enum	Pending Sent Failed Skipped
Pending Sent Failed Skipped
skipOrFailReason	string	Why this client was skipped or the send failed. Null when Pending or Sent.
Why this client was skipped or the send failed. Null when Pending or Sent.
sentDate	string	When the email was sent (UTC). Null unless Status is Sent.
When the email was sent (UTC). Null unless Status is Sent.

JSON Example

{
  "clientCode": "string",
  "clientName": "string",
  "toRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ],
  "ccRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ],
  "bccRecipients": [
    {
      "name": "...",
      "email": "..."
    }
  ]
}

Contained in Schemas

EmailBroadcastRecipientDtoPagedResult