CreateEmailBroadcastRequest

Request to create a draft email broadcast.
Provide either a ContentBlockCode or inline SubjectLine + BodyHtml (mutually exclusive).
Recipient selection combines an optional client filter with hand-picked additions and exclusions.

Properties

Name	Type	Description
contentBlockCode	string	Content block code (category: Email) used as the email template. Mutually exclusive with SubjectLine/BodyHtml — provide one or the other.
Content block code (category: Email) used as the email template. Mutually exclusive with SubjectLine/BodyHtml — provide one or the other.
subjectLine	string	Inline email subject line with Liquid template syntax. Must be provided together with BodyHtml. Mutually exclusive with ContentBlockCode.
Inline email subject line with Liquid template syntax. Must be provided together with BodyHtml. Mutually exclusive with ContentBlockCode.
bodyHtml	string	Inline email body HTML with Liquid template syntax. Must be provided together with SubjectLine. Mutually exclusive with ContentBlockCode.
Inline email body HTML with Liquid template syntax. Must be provided together with SubjectLine. 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 to include each client's business email (the email address on the client record) as a To recipient. Applies whether or not AllContacts is set.
Whether to include each client's business email (the email address on the client record) 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 and SpecificUser are not applicable for broadcasts. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
User types for To recipients (ClientManager, ClientPartner, ClientAssociate, ClientServiceManager), resolved per client at send time. TaskOwner and SpecificUser are not applicable for broadcasts. TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
additionalEmailAddresses	array of string	Static email addresses to include as To recipients on every email.
Static email addresses to include as To recipients on every email.
ccIncludeBusinessEmail	boolean	Whether to include each client's business email as a CC recipient.
Whether to include each client's business email 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 to include as CC recipients on every email.
Static email addresses to include as CC recipients on every email.
bccIncludeBusinessEmail	boolean	Whether to include each client's business email as a BCC recipient.
Whether to include each client's business email 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 to include as BCC recipients on every email.
Static email addresses to include as BCC recipients on every email.
savedViewCode	string	The code of a saved client view whose filter selects which clients to include. The view's criteria are resolved when recipients are resolved, so later changes to the view are picked up until the broadcast is sent. Mutually exclusive with Filter.
The code of a saved client view whose filter selects which clients to include. The view's criteria are resolved when recipients are resolved, so later changes to the view are picked up until the broadcast is sent. Mutually exclusive with Filter.
filter	EmailBroadcastFilterDto
excludedClientCodes	array of string	Client codes to exclude from the filter results.
Client codes to exclude from the filter results.
additionalClientCodes	array of string	Hand-picked client codes to add on top of the filter results.
Hand-picked client codes to add on top of the filter results.
onlyEmailableClients	boolean	When true (default), clients whose email contact preference is not set are skipped.
When true (default), clients whose email contact preference is not set are skipped.
addHeaderFooter	boolean	When true (default), the tenant's email header and footer content blocks are wrapped around the body when the email is rendered.
When true (default), 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. Omit to use the tenant's default mailbox resolution.
The email configuration (mailbox) code to send from. Omit to use the tenant's default mailbox resolution.

JSON Example

{
  "contentBlockCode": "string",
  "subjectLine": "string",
  "bodyHtml": "string",
  "allContacts": false,
  "recipientIncludeBusinessEmail": false
}

Used By Operations

POST Create Email Broadcast
/tenants/{tenant}/email-broadcasts