campaigns
POST /v1/campaigns/segments
Save a new audience segment.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/campaigns/segments \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "definition": <CampaignSegmentNode> }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
The definition is a filter tree over the fields GET /v1/campaigns/segments/fields lists, and is validated on write — a definition that cannot be compiled cannot be stored, so a saved segment never explodes at send time in front of an operator who has already scheduled it. ⛔ An empty group ({"op":"and","children":[]}) is refused rather than treated as "everybody": a half-built segment must not silently mean the entire estate.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
org_id (query) | string | Не | Which organization's campaigns to work on. Required only when you hold campaign access on more than one; staff always work on the platform scope and may omit it. |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
name | string | Да | — |
description | 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… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
id | string | Да | — |
org_id | string | Да | The segment's OWNER, not the orgs it selects. |
scope | string<platform, reseller> | Да | — |
name | string | Да | — |
description | 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… |
status | string<active, archived> | Да | — |
created_by | string | Не | — |
created_at | string | Не | — |
updated_at | string | Не | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 422