Campaigns

POST `/v1/campaigns/{campaignId}/control`

Pause, resume or cancel a running send.

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोटले JSON बडीमा एक फिल्डको रूपमा org_id लिन्छ।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

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 these,…
`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…

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 404 · 422

POST /v1/campaigns/{campaignId}/control