campaigns
PATCH /v1/campaigns/segments/{segmentId}
Rename a segment or change its filters.
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 PATCH https://api.zinndigital.com/v1/campaigns/segments/{segmentId} \
-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
scope is absent from the body and cannot be changed: a segment reviewed and approved as "my clients" must not silently become "the estate".
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
segmentId (path) | string | Yes | — |
org_id (query) | string | No | — |
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 · 404 · 422