campaigns
GET /v1/campaigns/segments/fields
The filter vocabulary, its value lists and the magic tags.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/campaigns/segments/fields \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
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.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id (query) | string | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
fields | CampaignSegmentField[] | Да | — |
choices | object | Да | Live value lists, restricted to your own population. |
merge_tags | string[] | Да | 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> | Да | — |
org_id | string | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403