Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Authenticatie
Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.
Waar je organisatie-id komt te staan
Dit eindpunt verwacht org_id als een veld in de JSON-body.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw 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>> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
campaignId (path) | string | Ja | — |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
action | string<pause, resume, cancel> | Ja | — |
org_id | string | Nee | — |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | string | Ja | — |
org_id | string | Ja | — |
name | string | Ja | — |
template_id | string | Ja | — |
segment_id | string | Nee | — |
purpose | string<marketing, transactional> | Ja | — |
channels | string[] | Ja | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Ja | — |
scheduled_for | string | Nee | — |
include_not_in_good_standing | boolean | Nee | — |
total_recipients | integer | Ja | — |
skipped | CampaignSkipCounts | Ja | ⛔ 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 | Nee | ⛔ `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 | Nee | — |
created_at | string | Ja | — |
started_at | string | Nee | — |
finished_at | string | Nee | — |
signal_delivered | boolean | Nee | ⛔ 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… |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422