EmailBroadcastDto

An email broadcast: an ad-hoc mass email to a filtered set of clients with per-client
Liquid token rendering. Returned by the email broadcast endpoints.

Properties

Name	Type	Description
code	string	Unique code identifying this broadcast
Unique code identifying this broadcast
status	enum	Draft Queued Sending Completed Failed Cancelled
Draft Queued Sending Completed Failed Cancelled
contentBlockCode	string	Content block code (category: Email) used as the email template. Mutually exclusive with SubjectLine/BodyHtml.
Content block code (category: Email) used as the email template. Mutually exclusive with SubjectLine/BodyHtml.
subjectLine	string	Inline email subject line with Liquid template syntax. Mutually exclusive with ContentBlockCode.
Inline email subject line with Liquid template syntax. Mutually exclusive with ContentBlockCode.
bodyHtml	string	Inline email body HTML with Liquid template syntax. Mutually exclusive with ContentBlockCode.
Inline email body HTML with Liquid template syntax. Mutually exclusive with ContentBlockCode.
allContacts	boolean	When true, every contact of each client with an email address receives the email as a To recipient, regardless of contact type. RecipientContactTypes is ignored.
When true, every contact of each client with an email address receives the email as a To recipient, regardless of contact type. RecipientContactTypes is ignored.
recipientIncludeBusinessEmail	boolean	Whether each client's business email (the email address on the client record) is included as a To recipient. Applies whether or not AllContacts is set.
Whether each client's business email (the email address on the client record) is included as a To recipient. Applies whether or not AllContacts is set.
recipientContactTypes	array of enum	Client contact types for To recipients, resolved per client at send time. Ignored when AllContacts is true. Main Billing Payroll Accounts Director Psc
Client contact types for To recipients, resolved per client at send time. Ignored when AllContacts is true. Main Billing Payroll Accounts Director Psc
recipientUserTypes	array of enum	User types for To recipients (ClientManager, ClientPartner, ClientAssociate, ClientServiceManager), resolved per client at send time. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
User types for To recipients (ClientManager, ClientPartner, ClientAssociate, ClientServiceManager), resolved per client at send time. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
additionalEmailAddresses	array of string	Static email addresses included as To recipients on every email.
Static email addresses included as To recipients on every email.
ccIncludeBusinessEmail	boolean	Whether each client's business email is included as a CC recipient.
Whether each client's business email is included as a CC recipient.
ccContactTypes	array of enum	Client contact types for CC recipients. Main Billing Payroll Accounts Director Psc
Client contact types for CC recipients. Main Billing Payroll Accounts Director Psc
ccUserTypes	array of enum	User types for CC recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
User types for CC recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
ccEmailAddresses	array of string	Static email addresses included as CC recipients on every email.
Static email addresses included as CC recipients on every email.
bccIncludeBusinessEmail	boolean	Whether each client's business email is included as a BCC recipient.
Whether each client's business email is included as a BCC recipient.
bccContactTypes	array of enum	Client contact types for BCC recipients. Main Billing Payroll Accounts Director Psc
Client contact types for BCC recipients. Main Billing Payroll Accounts Director Psc
bccUserTypes	array of enum	User types for BCC recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
User types for BCC recipients. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
bccEmailAddresses	array of string	Static email addresses included as BCC recipients on every email.
Static email addresses included as BCC recipients on every email.
savedView	CodeAndNameDto
filter	EmailBroadcastFilterDto
excludedClientCodes	array of string	Client codes excluded from the filter results.
Client codes excluded from the filter results.
additionalClientCodes	array of string	Hand-picked client codes added on top of the filter results.
Hand-picked client codes added on top of the filter results.
onlyEmailableClients	boolean	When true, clients whose email contact preference is not set are skipped.
When true, clients whose email contact preference is not set are skipped.
addHeaderFooter	boolean	When true, the tenant's email header and footer content blocks are wrapped around the body when the email is rendered.
When true, the tenant's email header and footer content blocks are wrapped around the body when the email is rendered.
configCode	string	The email configuration (mailbox) code to send from. Null uses the tenant's default mailbox resolution.
The email configuration (mailbox) code to send from. Null uses the tenant's default mailbox resolution.
totalClients	integer	Total number of sendable recipients, set when the broadcast is sent.
Total number of sendable recipients, set when the broadcast is sent.
processedClients	integer	Number of recipients processed so far (sent + failed). Compare with TotalClients to calculate progress.
Number of recipients processed so far (sent + failed). Compare with TotalClients to calculate progress.
failedClients	integer	Number of recipients that failed so far.
Number of recipients that failed so far.
startedDate	string	When the broadcast started sending (UTC). Null until processing starts.
When the broadcast started sending (UTC). Null until processing starts.
completedDate	string	When the broadcast finished processing (UTC). Set for completion, failure and cancellation.
When the broadcast finished processing (UTC). Set for completion, failure and cancellation.
createdDate	string	When the broadcast was created (UTC).
When the broadcast was created (UTC).

JSON Example

{
  "code": "string",
  "status": "Draft",
  "contentBlockCode": "string",
  "subjectLine": "string",
  "bodyHtml": "string"
}

Used By Operations

Contained in Schemas

EmailBroadcastDtoPagedResult