Preview who a campaign would reach
previewSendWork out exactly how many contacts a campaign to this segment would actually reach right now, and why the rest would not - suppressed, unsubscribed, mailed too recently, or over today's limit. Always do this before proposing a send.
Only for a workspace with subscribed email contacts.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| segmentKey | Yes | Which audience: 'all', a segment's key, or a segment's id, exactly as readSegments gives them | |
| workspaceId | No | The workspace, as listWorkspaces gives it (its id or slug). Leave it out when this connection reaches one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caveats | Yes | What this preview cannot see | |
| sampled | Yes | The audience was too large to count in full; the numbers are for the first part of it | |
| audience | Yes | Contacts in the segment, before anything is taken out | |
| reachable | Yes | How many would be mailed right now | |
| suppressed | Yes | On the suppression list: bounced or complained | |
| notSubscribed | Yes | ||
| dailyRemaining | Yes | What is left of today's sending allowance; null when the plan has no daily cap | |
| frequencyCapped | Yes | Mailed too recently | |
| deferredToTomorrow | Yes | Would be mailed, but over today's sending allowance, so they wait |