Skip to main content
POST
Preview a campaign audience size and sample

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
audience_type
enum<string>
default:all

How the audience is selected.

Available options:
all,
list,
segment,
csv,
manual
audience_id
string

Identifier of the list or segment to preview. Required when audience_type is list or segment.

csv_recipients
string[]

Raw recipient identifiers when audience_type is csv.

contact_ids
string[]

Hand-picked contact ids when audience_type is manual.

channel
string

When provided, the response includes a channel-aware net-recipient projection.

Response

200 - application/json

Audience size, sample, and net-recipient projection

Audience size, sample, and net-recipient projection

data
object
meta
object