campaigns

POST `/v1/campaigns/segments/preview`

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

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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.

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`org_id (query)`	`string`	Tidak	—

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`definition`	`CampaignSegmentNode`	Tidak	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`	Tidak	—
`channel`	`string`	Tidak	—
`purpose`	`string<marketing, transactional>`	Tidak	`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`	Tidak	⚖️ 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`	Tidak	—
`record_approval`	`boolean`	Tidak	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…

Respons

Nama	Jenis	Diperlukan	Apakah ia
`snapshot_id`	`string`	Tidak	The approval record's id when `record_approval` was set; `null` otherwise.
`total`	`integer`	Ya	The TRUE recipient count — not the length of `sample`. Show this number, and show the skips beside it.
`skipped_not_in_good_standing`	`integer`	Ya	—
`skipped_no_marketing_consent`	`integer`	Ya	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`	Ya	—
`skipped_channel_muted`	`integer`	Ya	—
`skipped_no_destination`	`integer`	Ya	Accounts with no member carrying an address on this channel.
`skipped_total`	`integer`	Ya	—
`truncated`	`boolean`	Ya	True when `sample` is shorter than `total`.
`evaluated_at`	`string`	Ya	—
`scope`	`string<platform, reseller>`	Ya	—
`sample`	`object[]`	Ya	—

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 422