EmailBroadcastAudienceRequest
The client-selection part of an email broadcast, used to summarise the audience
before a draft exists. Same selection semantics as create: a saved view or an
inline filter (mutually exclusive), plus hand-picked additions and exclusions.
Optionally include the To-recipient configuration to also count clients with
no resolvable email address.
Properties
| Name | Type | Description |
|---|---|---|
| savedViewCode | string | The code of a saved client view whose filter selects which clients to include. |
The code of a saved client view whose filter selects which clients to include. | ||
| 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. | ||
| allContacts | boolean | When true, every contact of each client with an email address is a To recipient. |
When true, every contact of each client with an email address is a To recipient. | ||
| recipientIncludeBusinessEmail | boolean | Whether each client's business email (the email address on the client record) is a |
Whether each client's business email (the email address on the client record) is a | ||
| recipientContactTypes | array of enum | Client contact types for To recipients. Part of the optional To-recipient configuration. |
Client contact types for To recipients. Part of the optional To-recipient configuration. | ||
| recipientUserTypes | array of enum | User types for To recipients. Part of the optional To-recipient configuration. |
User types for To recipients. Part of the optional To-recipient configuration. | ||
| additionalEmailAddresses | array of string | Static email addresses included as To recipients on every email. |
Static email addresses included as To recipients on every email. | ||
JSON Example
{
"savedViewCode": "string",
"filter": {
"managerCodes": [
"..."
],
"partnerCodes": [
"..."
],
"associateCodes": [
"..."
],
"statuses": [
"..."
],
"types": [
"..."
]
},
"excludedClientCodes": [
"string"
],
"additionalClientCodes": [
"string"
],
"allContacts": false
}