Campaigns
DELETE /v1/campaigns/esp
Disconnect the provider account and remove its stored key.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X DELETE https://api.zinndigital.com/v1/campaigns/esp \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
Forget this organisation's e-mail provider. The stored key is removed from Vault, not merely hidden — and campaigns refuse to send until a provider is connected again.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
org_id (query) | Uuid | Ні | The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency… |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
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