Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Де вказується ідентифікатор вашої організації
Цей ендпоінт приймає org_id як поле в тілі JSON.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X POST https://api.zinndigital.com/v1/campaigns/{campaignId}/control \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "action": <string<pause, resume, cancel>> }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
The decision is written to the database first and signalled second, so a worker that restarted and never saw the signal still stops on its next batch.
Параметри
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
campaignId (path) | string | Так | — |
Тіло запиту
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
action | string<pause, resume, cancel> | Так | — |
org_id | string | Ні | — |
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
id | string | Так | — |
org_id | string | Так | — |
name | string | Так | — |
template_id | string | Так | — |
segment_id | string | Ні | — |
purpose | string<marketing, transactional> | Так | — |
channels | string[] | Так | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Так | — |
scheduled_for | string | Ні | — |
include_not_in_good_standing | boolean | Ні | — |
total_recipients | integer | Так | — |
skipped | CampaignSkipCounts | Так | ⛔ Every skip counted separately and never silent, and **every one is present even when it is zero**. "4,127 recipients, 312 skipped — not in good standing" is rendered from thes… |
delivery | 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… |
last_error | string | Ні | — |
created_at | string | Так | — |
started_at | string | Ні | — |
finished_at | string | Ні | — |
signal_delivered | boolean | Ні | ⛔ Reported honestly. `false` means the decision is recorded and the running workflow was not reachable — it will still stop on its next batch, but that is a real difference an o… |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404 · 422