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}