campaigns

POST `/v1/campaigns/segments/preview`

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

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այs վերջնակետը ընդունում է org_id-ը որպես հարցման պարամետր: Բաց թողեք այն, և կանչը կընդգրկի ձեր ամբողջ վարձակալության ենթածառը. ուղարկեք այն՝ կանչը մեկ կազմակերպության վրա սահմանափակելու համար:

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

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.

Պարամետրեր

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`org_id (query)`	`string`	Ոչ	—

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`definition`	`CampaignSegmentNode`	Ոչ	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`	Ոչ	—
`channel`	`string`	Ոչ	—
`purpose`	`string<marketing, transactional>`	Ոչ	`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`	Ոչ	⚖️ 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`	Ոչ	—
`record_approval`	`boolean`	Ոչ	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…

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`snapshot_id`	`string`	Ոչ	The approval record's id when `record_approval` was set; `null` otherwise.
`total`	`integer`	Այո	The TRUE recipient count — not the length of `sample`. Show this number, and show the skips beside it.
`skipped_not_in_good_standing`	`integer`	Այո	—
`skipped_no_marketing_consent`	`integer`	Այո	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`	Այո	—
`skipped_channel_muted`	`integer`	Այո	—
`skipped_no_destination`	`integer`	Այո	Accounts with no member carrying an address on this channel.
`skipped_total`	`integer`	Այո	—
`truncated`	`boolean`	Այո	True when `sample` is shorter than `total`.
`evaluated_at`	`string`	Այո	—
`scope`	`string<platform, reseller>`	Այո	—
`sample`	`object[]`	Այո	—

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 422

POST /v1/campaigns/segments/preview