Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
L'ID della tua organizzazione va qui
Questo endpoint accetta org_id come campo nel corpo JSON.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
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>> }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
campaignId (path) | string | Sì | — |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
action | string<pause, resume, cancel> | Sì | — |
org_id | string | No | — |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | string | Sì | — |
org_id | string | Sì | — |
name | string | Sì | — |
template_id | string | Sì | — |
segment_id | string | No | — |
purpose | string<marketing, transactional> | Sì | — |
channels | string[] | Sì | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Sì | — |
scheduled_for | string | No | — |
include_not_in_good_standing | boolean | No | — |
total_recipients | integer | Sì | — |
skipped | CampaignSkipCounts | Sì | ⛔ 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 | No | ⛔ `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 | No | — |
created_at | string | Sì | — |
started_at | string | No | — |
finished_at | string | No | — |
signal_delivered | boolean | No | ⛔ 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… |
Errori che questo endpoint può restituire
401 · 403 · 404 · 422