campaigns

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

Rename a segment or change its filters.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Unde merge ID-ul organizației tale

Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.

ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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

Parametri

Nume	Tip	Obligatoriu	Ce este
`segmentId (path)`	`string`	Da	—
`org_id (query)`	`string`	Nu	—

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`name`	`string`	Da	—
`description`	`string`	Nu	—
`definition`	`CampaignSegmentNode`	Da	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…

Răspuns

Nume	Tip	Obligatoriu	Ce este
`id`	`string`	Da	—
`org_id`	`string`	Da	The segment's OWNER, not the orgs it selects.
`scope`	`string<platform, reseller>`	Da	—
`name`	`string`	Da	—
`description`	`string`	Nu	—
`definition`	`CampaignSegmentNode`	Da	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>`	Da	—
`created_by`	`string`	Nu	—
`created_at`	`string`	Nu	—
`updated_at`	`string`	Nu	—

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422