campaigns
POST /v1/campaigns/segments
Save a new audience segment.
Authentication
Send an API key as a bearer token. The endpoint checks campaigns.manage; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
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> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | string | No | 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. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | Yes | — |
description | string | No | — |
definition | CampaignSegmentNode | Yes | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
org_id | string | Yes | The segment's OWNER, not the orgs it selects. |
scope | string<platform, reseller> | Yes | — |
name | string | Yes | — |
description | string | No | — |
definition | CampaignSegmentNode | Yes | 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> | Yes | — |
created_by | string | No | — |
created_at | string | No | — |
updated_at | string | No | — |
Errors this endpoint can return
401 · 403 · 422