Ad-hoc mass emails to a filtered set of clients with per-client Liquid token rendering. Provides draft CRUD, a pre-send resolved recipient list with skip warnings (missing contacts, email contact preference), per-client preview, test send to the current user, async sending with progress counters, a per-client delivery log, and cancellation. Recipient selection combines client filters with hand-picked additions and exclusions; recipients are resolved from client contact types, user types (manager/partner/associate/service manager), and static addresses — the same configuration shape as SendEmail workflow steps.

List Email Broadcasts

GET /tenants/{tenant}/email-broadcasts

Returns a paged list of email broadcasts for the tenant, newest first. Filter by status.

Parameters

Name	Type	Description
tenant*	path string	The Tenant.Code
The Tenant.Code
offset	query integer (int32)	Number of records to skip (default: 0). Use with limit for pagination.
Number of records to skip (default: 0). Use with limit for pagination.
limit	query integer (int32)	Maximum number of records to return (default: 10, max: 50)
Maximum number of records to return (default: 10, max: 50)
sortBy	query enum	Field to sort by. CreatedDate Status
Field to sort by. CreatedDate Status
sortDesc	query boolean	Sort in descending order (true) or ascending order (false, default)
Sort in descending order (true) or ascending order (false, default)
status	query string	Filter by broadcast status (Draft, Queued, Sending, Completed, Failed, Cancelled)
Filter by broadcast status (Draft, Queued, Sending, Completed, Failed, Cancelled)

Responses

200 OK

EmailBroadcastDtoPagedResult

401 Unauthorized – Invalid or missing API key

List Email Broadcasts

Parameters

Responses

Try it

Related Schemas

EmailBroadcastDtoPagedResult