Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
प्रमाणन
एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट JSON बॉडी में एक फ़ील्ड के रूप में org_id लेता है।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
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>> }'साइन इन हैं? आपके डैशबोर्ड में मौजूद 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