Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Sem patří ID vaší organizace
Tento koncový bod přijímá org_id jako pole v těle JSON.
ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
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>> }'Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
campaignId (path) | string | Ano | — |
Tělo požadavku
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
action | string<pause, resume, cancel> | Ano | — |
org_id | string | Ne | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | string | Ano | — |
org_id | string | Ano | — |
name | string | Ano | — |
template_id | string | Ano | — |
segment_id | string | Ne | — |
purpose | string<marketing, transactional> | Ano | — |
channels | string[] | Ano | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Ano | — |
scheduled_for | string | Ne | — |
include_not_in_good_standing | boolean | Ne | — |
total_recipients | integer | Ano | — |
skipped | CampaignSkipCounts | Ano | ⛔ 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 | Ne | ⛔ 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 | Ne | — |
created_at | string | Ano | — |
started_at | string | Ne | — |
finished_at | string | Ne | — |
signal_delivered | boolean | Ne | ⛔ 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… |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 422