campaigns
GET /v1/campaigns/segments/fields
The filter vocabulary, its value lists and the magic tags.
Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Təşkilatınızın identifikatorunun yerləşdiyi yer
Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.
Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
curl -X GET https://api.zinndigital.com/v1/campaigns/segments/fields \
-H "Authorization: Bearer zdk_live_…"Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
org_id (query) | string | Xeyr | — |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
fields | CampaignSegmentField[] | Bəli | — |
choices | object | Bəli | Live value lists, restricted to your own population. |
merge_tags | string[] | Bəli | 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> | Bəli | — |
org_id | string | Bəli | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403