Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Autentifikatsiya
API kalitini bearer token sifatida yuboring. Ushbu yakuniy nuqta spetsifikatsiyada ma'lum bir ruxsatni ko'rsatmaydi, shuning uchun kalitingizga eng kam kerakli huquqni bering va taxmin qilish o'rniga javobni tekshiring.
Tashkilotingiz identifikatori kiritiladigan joy
Ushbu so'rov JSON tanasida org_id ni maydon sifatida qabul qiladi.
Tashkilotingiz identifikatori boshqaruv panelingizdagi API kalitlari ekranida, kalitning o'z yonida joylashgan. Bu siz amalga oshiradigan har bir so'rovda bir xil identifikator hisoblanadi.
Sinab ko'rish
Qavslardagi har qanday narsani o'z qiymatlaringiz bilan, kalit pleysxolderini эsa boshqaruv panelingizdagi kalit bilan almashtiring.
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>> }'Tizimga kirganmisiz? Boshqaruv panelingizdagi API konsoli haqiqiy tashkilot ID raqamingiz va shaxsiy kalitingizni avtomatik to'ldiradi hamda haqiqiy javobni ko'rishingiz uchun so'rovni jonli API orqali bajaradi. Ushbu yakuniy nuqtani API konsolida oching
Tafsilotlar
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.
Parametrlar
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
campaignId (path) | string | Ha | — |
Soʻrov tanasi
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
action | string<pause, resume, cancel> | Ha | — |
org_id | string | Yo'q | — |
Javob
| Nomi | Turi | Majburiy | Nima bu |
|---|---|---|---|
id | string | Ha | — |
org_id | string | Ha | — |
name | string | Ha | — |
template_id | string | Ha | — |
segment_id | string | Yo'q | — |
purpose | string<marketing, transactional> | Ha | — |
channels | string[] | Ha | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Ha | — |
scheduled_for | string | Yo'q | — |
include_not_in_good_standing | boolean | Yo'q | — |
total_recipients | integer | Ha | — |
skipped | CampaignSkipCounts | Ha | ⛔ 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 | Yo'q | ⛔ `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 | Yo'q | — |
created_at | string | Ha | — |
started_at | string | Yo'q | — |
finished_at | string | Yo'q | — |
signal_delivered | boolean | Yo'q | ⛔ 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… |
Ushbu yakuniy nuqta qaytarishi mumkin bo'lgan xatolar
401 · 403 · 404 · 422