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, за да можете да видите действителния отговор. Отворете този крайpoint в 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`	Не	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

PATCH /v1/campaigns/segments/{segmentId}