campaigns

POST `/v1/campaigns/segments/preview`

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

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

جہاں آپ کی تنظیم کی آئی ڈی آتی ہے

یہ اینڈ پوائنٹ org_id کو بطور کوئری پیرامیٹر لیتا ہے۔ اسے چھوڑ دیں اور کال آپ کے پورے ٹیننسی سب ٹری کا احاطہ کرے گی؛ کال کو کسی ایک آرگنائزیشن تک محدود کرنے کے لیے اسے بھیجیں۔

آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو 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