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