campaigns

GET `/v1/campaigns/segments/fields`

The filter vocabulary, its value lists and the magic tags.

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

L'ID della tua organizzazione va qui

Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

curl -X GET https://api.zinndigital.com/v1/campaigns/segments/fields \
  -H "Authorization: Bearer zdk_live_…"

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

Everything a segment builder needs to render itself: the filterable fields with their operators and a hint each, the live value lists for the `choice` fields, and the merge tags a template may use. The value lists are restricted to your own population — a reseller's country picker lists the countries their clients are actually in, not every country the platform sells into.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`org_id (query)`	`string`	No	—

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`fields`	`CampaignSegmentField[]`	Sì	—
`choices`	`object`	Sì	Live value lists, restricted to your own population.
`merge_tags`	`string[]`	Sì	The magic tags a template may use. Every one resolves to a STRING for every recipient — never null, never absent, so no message can begin "Hi ,".
`scope`	`string<platform, reseller>`	Sì	—
`org_id`	`string`	Sì	—

Errori che questo endpoint può restituire

401 · 403