Skip to main content
POST
Preview a CRM or CDP account 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
type
string
required

Audience source type — a CRM-backed type (hubspot_list, salesforce_report, salesforce_list_view, pipedrive_filter) or cdp_account. orbit_segment is rejected.

ref
string

Provider container reference (list/report/filter id, or the CDP account group_id). Required unless type is orbit_segment.

sobject
enum<string>

Salesforce object to resolve (Contact or Lead).

Available options:
Contact,
Lead

Response

Resolved count + contact sample; skipped_* counts explain rows dropped for missing contact info or duplication.

Resolved count + contact sample; skipped_* counts explain rows dropped for missing contact info or duplication.

data
object
meta
object