Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Autentikasi
Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.
Tempat ID organisasi Anda dimasukkan
Titik akhir ini memerlukan org_id sebagai field dalam bodi JSON.
ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
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>> }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
campaignId (path) | string | Ya | — |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
action | string<pause, resume, cancel> | Ya | — |
org_id | string | Tidak | — |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | string | Ya | — |
org_id | string | Ya | — |
name | string | Ya | — |
template_id | string | Ya | — |
segment_id | string | Tidak | — |
purpose | string<marketing, transactional> | Ya | — |
channels | string[] | Ya | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Ya | — |
scheduled_for | string | Tidak | — |
include_not_in_good_standing | boolean | Tidak | — |
total_recipients | integer | Ya | — |
skipped | CampaignSkipCounts | Ya | ⛔ 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 | Tidak | ⛔ `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 | Tidak | — |
created_at | string | Ya | — |
started_at | string | Tidak | — |
finished_at | string | Tidak | — |
signal_delivered | boolean | Tidak | ⛔ 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… |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422