campaigns

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

Rename a segment or change its filters.

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այs վերջնակետը ընդունում է org_id-ը որպես հարցման պարամետր: Բաց թողեք այն, և կանչը կընդգրկի ձեր ամբողջ վարձակալության ենթածառը. ուղարկեք այն՝ կանչը մեկ կազմակերպության վրա սահմանափակելու համար:

Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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 վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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}