campaigns

GET /v1/campaigns/segments/fields

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

Wszystkie punkty końcowe campaigns

Wszystkie dokumentacje dla programistów

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

NazwaTypWymaganeCo to jest
org_id (query)stringNie

Odpowiedź

NazwaTypWymaganeCo to jest
fieldsCampaignSegmentField[]Tak
choicesobjectTakLive value lists, restricted to your own population.
merge_tagsstring[]TakThe 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 ,".
scopestring<platform, reseller>Tak
org_idstringTak

Błędy, które ten punkt końcowy może zwrócić

401 · 403