Campaigns
POST /v1/campaigns/esp/verify
Prove the provider account works and read its verified domains.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве поля в теле JSON.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X POST https://api.zinndigital.com/v1/campaigns/esp/verify \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
A real call to the provider. Configured is not proved — a connection is unusable until this has succeeded, and the response distinguishes "not connected" from "unverified" from "rejected" so the operator knows which one they are in.
Тело запроса
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
org_id | string | Нет | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
connected | boolean | Да | — |
id | string | Нет | — |
provider | string | Да | — |
status | string<not_connected, unverified, verified, rejected> | Да | — |
from_address | string | Нет | — |
from_local_part | string | Нет | — |
from_display_name | string | Нет | — |
sending_domain | string | Нет | — |
reply_to | string | Нет | — |
verified_domains | EspVerifiedDomain[] | Нет | — |
last_verified_at | string | Нет | — |
last_error | string | Нет | — |
stats | CampaignDeliveryCounts | Нет | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 422