Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Где се уноси ID ваше организације
Ова крајња тачка узима 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 конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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 these,… |
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… |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422