Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
A szervezet azonosítójának helye
Ez a végpont a org_id mezőt várja a JSON törzsben.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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>> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
campaignId (path) | string | Igen | — |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
action | string<pause, resume, cancel> | Igen | — |
org_id | string | Nem | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | string | Igen | — |
org_id | string | Igen | — |
name | string | Igen | — |
template_id | string | Igen | — |
segment_id | string | Nem | — |
purpose | string<marketing, transactional> | Igen | — |
channels | string[] | Igen | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Igen | — |
scheduled_for | string | Nem | — |
include_not_in_good_standing | boolean | Nem | — |
total_recipients | integer | Igen | — |
skipped | CampaignSkipCounts | Igen | ⛔ 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 | Nem | ⛔ `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 | Nem | — |
created_at | string | Igen | — |
started_at | string | Nem | — |
finished_at | string | Nem | — |
signal_delivered | boolean | Nem | ⛔ 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… |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 422