campaigns

PATCH `/v1/campaigns/segments/{segmentId}`

Rename a segment or change its filters.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

`scope` is absent from the body and cannot be changed: a segment reviewed and approved as "my clients" must not silently become "the estate".

Параметри

Назва	Тип	Обов'язкове	Що це таке
`segmentId (path)`	`string`	Так	—
`org_id (query)`	`string`	Ні	—

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`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 · 404 · 422

PATCH /v1/campaigns/segments/{segmentId}