Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Autentifikacija
Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.
Gdje dolazi ID vaše organizacije
Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.
ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
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>> }'Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
campaignId (path) | string | Da | — |
Tijelo zahtjeva
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
action | string<pause, resume, cancel> | Da | — |
org_id | string | Ne | — |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
id | string | Da | — |
org_id | string | Da | — |
name | string | Da | — |
template_id | string | Da | — |
segment_id | string | Ne | — |
purpose | string<marketing, transactional> | Da | — |
channels | string[] | Da | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Da | — |
scheduled_for | string | Ne | — |
include_not_in_good_standing | boolean | Ne | — |
total_recipients | integer | Da | — |
skipped | CampaignSkipCounts | Da | ⛔ 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 | 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 | Da | — |
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 o… |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 404 · 422