Skip to main content
POST
Preview a native campaign audience

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
audience_type
enum<string>

Audience strategy. Defaults to all.

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

Id of the list or segment when audience_type is list or segment.

csv_recipients
string[]

Raw recipients when audience_type is csv.

contact_ids
string[]

Hand-picked contact ids when audience_type is manual.

channel
string

Optional channel — when supplied the response also carries the net reachability projection (suppression + opt-outs + advisory frequency-cap estimate).

Response

Gross count, sample, and (when channel was supplied) the cohort net projection.

Gross count, sample, and (when channel was supplied) the cohort net projection.

data
object
meta
object