Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
org_id (query) | string | Ne | 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. |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
name | string | Ano | — |
description | string | Ne | — |
definition | CampaignSegmentNode | Ano | 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… |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
org_id | string | Ano | The segment's OWNER, not the orgs it selects. |
scope | string<platform, reseller> | Ano | — |
name | string | Ano | — |
description | string | Ne | — |
definition | CampaignSegmentNode | Ano | 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> | Ano | — |
created_by | string | Ne | — |
created_at | string | Ne | — |
updated_at | string | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 422