Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Санҷиши ҳаққоният
Kalitи API-ро ҳамчун token-и bearer фиристед. Ин нуқтаи ниҳоӣ дар мушаххасот иҷозати мушаххасеро нишон намедиҳад, бинобар ин ба калиди худ ҳадди ақали заруриро диҳед ва ба ҷои тахмин кардан, ҷавобро санҷед.
Ҷое, ки рақами мушаххаси ташкилоти шумо ҷойгир аст
Ин нуқтаи поёнӣ org_id -ро ҳамчун майдон дар бадани JSON мегирад.
Rakami муайянкунандаи ташкилоти шумо дар экрани калидҳои API дар панели идоракунии шумо, дар паҳлӯи худи калид ҷойгир аст. Ин як раками муайянкунанда дар ҳар یک дархосте, ки шумо иҷро мекунед, якхела аст.
Санҷидан
Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.
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>> }'Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед
Тафсилот
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.
Параметрҳо
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
campaignId (path) | string | Бале | — |
Ҷисми дархост
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
action | string<pause, resume, cancel> | Бале | — |
org_id | string | Не | — |
Ҷавоб
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
id | string | Бале | — |
org_id | string | Бале | — |
name | string | Бале | — |
template_id | string | Бале | — |
segment_id | string | Не | — |
purpose | string<marketing, transactional> | Бале | — |
channels | string[] | Бале | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Бале | — |
scheduled_for | string | Не | — |
include_not_in_good_standing | boolean | Не | — |
total_recipients | integer | Бале | — |
skipped | CampaignSkipCounts | Бале | ⛔ 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 | Не | ⛔ `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 | Не | — |
created_at | string | Бале | — |
started_at | string | Не | — |
finished_at | string | Не | — |
signal_delivered | boolean | Не | ⛔ 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… |
Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад
401 · 403 · 404 · 422