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.

Send Test Email

POST /tenants/{tenant}/email-broadcasts/{code}/test

Renders the broadcast for the sample client in the request body and sends it to the current user's own email address only.

Parameters

Name	Type	Description
tenant*	path string	The Tenant.Code
The Tenant.Code
code*	path string

Request Body*

TestEmailBroadcastRequest

{
  "clientCode": "string"
}

Responses

204 No Content

400 Bad Request

401 Unauthorized – Invalid or missing API key

404 Not Found

Send Test Email

Parameters

Request Body*

Responses

Try it

Related Schemas

TestEmailBroadcastRequest