campaigns

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

Rename a segment or change its filters.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`segmentId (path)`	`string`	Ano	—
`org_id (query)`	`string`	Ne	—

Tělo požadavku

Název	Typ	Požadováno	Co to je
`name`	`string`	Ano	—
`description`	`string`	Ne	—
`definition`	`CampaignSegmentNode`	Ano	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…

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`string`	Ano	—
`org_id`	`string`	Ano	The segment's OWNER, not the orgs it selects.
`scope`	`string<platform, reseller>`	Ano	—
`name`	`string`	Ano	—
`description`	`string`	Ne	—
`definition`	`CampaignSegmentNode`	Ano	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>`	Ano	—
`created_by`	`string`	Ne	—
`created_at`	`string`	Ne	—
`updated_at`	`string`	Ne	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422