Sign in
crm-email

Preview a CRM email audience

Admin-only. Resolves how many emails a send would actually deliver (commercial-communications opt-outs excluded) and estimates when the send finishes, accounting for the per-minute throttle and the nightly quiet-hours pause. Resolving the count costs about as much as the first send wave.

post/api/campaigns/preview

Request body

patient_statesstring[]

Stato paziente filters.

patient_filtersstring[]

Deprecated alias of patient_states.

registration_reasonsstring[]

Motivo iscrizione filters.

filter_match'any' | 'all'

How stato and motivo filters combine: 'any' (OR, default) unions them; 'all' (AND) keeps only patients matching both a selected stato and a selected motivo.

recipient_emailsstring[]

Explicit recipient emails (CSV); take priority over the filters.

scheduled_atstring date-time nullable

Planned send start for the completion estimate (defaults to now).

Response

Successful Response

recipient_countinteger required

Audience size (filters: a COUNT excluding commercial opt-outs, exact for a single filter; CSV: uploaded addresses, opt-outs not resolved so possibly high).

over_thresholdboolean required

True when the audience exceeds the throttle threshold (send is staggered).

throttle_rate_per_minuteinteger required

Emails per wave when throttled.

throttle_thresholdinteger required

At/below this size the send goes out in a single wave.

scheduled_atstring date-time required

Start time used for the estimate.

estimated_completion_atstring date-time nullable

Estimated time the last email is dispatched, accounting for the per-minute throttle and the nightly quiet-hours pause. Null for an empty audience.

Changes

No recorded changes to this endpoint across all 1 revision of this API.