campaigns

POST `/v1/campaigns/segments/preview`

How many people this reaches, who they are, and who it leaves out.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Kigezo hiki kinachukua org_id kama kigezo cha utafutaji. Iache wazi na simu itashughulikia tawi lako lote la wapangaji; itume ili kupunguza simu iwe ya shirika moja tu.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

curl -X POST https://api.zinndigital.com/v1/campaigns/segments/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

Pass either a `definition` (to preview an unsaved segment as you build it) or a `segment_id` — exactly one. ⛔ `total` is the TRUE recipient count and `sample` is a bounded illustration of it. They are different numbers and `truncated` says when: an operator who reads the sample size as the audience size sends thousands of emails believing they sent twenty. Every response carries all five skip counters whether or not any is non-zero, because a counter that disappears when it is zero is indistinguishable from a fence that never ran. `skipped_no_marketing_consent` will be large today: marketing is soft opt-in for people who are or were customers, and anyone else needs an explicit opt-in.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`org_id (query)`	`string`	Hapana	—

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`definition`	`CampaignSegmentNode`	Hapana	A filter tree. Two node shapes and no third: a GROUP (`op` with `children`) or a CONDITION (`field`/`operator`/`value`). `not` takes exactly one child — an n-ary `not` reads as…
`segment_id`	`string`	Hapana	—
`channel`	`string`	Hapana	—
`purpose`	`string<marketing, transactional>`	Hapana	`marketing` applies the consent fence and the suppression list; `transactional` applies neither — a service notice is not silenced by "stop sending me offers".
`include_not_in_good_standing`	`boolean`	Hapana	⚖️ Owner ruling 2026-08-26. Suspended and unpaid accounts are excluded by DEFAULT, because a send costs money (CLAUDE.md §2.46). Set this to reach them anyway — which is what a…
`limit`	`integer`	Hapana	—
`record_approval`	`boolean`	Hapana	Persist this resolution as an immutable approval record — what the operator saw and agreed to, stamped at the moment they agreed. Returns its id as `snapshot_id`. ⛔ Requires…

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`snapshot_id`	`string`	Hapana	The approval record's id when `record_approval` was set; `null` otherwise.
`total`	`integer`	Ndiyo	The TRUE recipient count — not the length of `sample`. Show this number, and show the skips beside it.
`skipped_not_in_good_standing`	`integer`	Ndiyo	—
`skipped_no_marketing_consent`	`integer`	Ndiyo	People the soft opt-in does not cover — a trial that never converted, an imported contact — who hold no explicit opt-in.
`skipped_unsubscribed`	`integer`	Ndiyo	—
`skipped_channel_muted`	`integer`	Ndiyo	—
`skipped_no_destination`	`integer`	Ndiyo	Accounts with no member carrying an address on this channel.
`skipped_total`	`integer`	Ndiyo	—
`truncated`	`boolean`	Ndiyo	True when `sample` is shorter than `total`.
`evaluated_at`	`string`	Ndiyo	—
`scope`	`string<platform, reseller>`	Ndiyo	—
`sample`	`object[]`	Ndiyo	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 422