Campaigns
POST /v1/campaigns
Create a campaign from a template and an audience.
प्रमाणीकरण
बेअरर टोकन म्हणून API की पाठवा. या एंडपॉईंटने स्पष्टीकरणामध्ये ठराविक परवानगी नमूद केलेली नाही, त्यामुळे तुमच्या कीला आवश्यक तेवढाच कमीत कमी ॲक्सेस द्या आणि गृहीत धरण्याऐवजी प्रतिसाद तपासा.
जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल
हा एंडपॉइंट JSON बॉडीमधील फील्ड म्हणून org_id घेतो.
तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.
प्रयत्न करा
कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.
curl -X POST https://api.zinndigital.com/v1/campaigns \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string>, "template_id": <string> }'साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील API कन्सोल तुमची खरी संस्था आयडी आणि तुमची स्वतःची की आपोआप भरतो आणि लाइव्ह API विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा
तपशील
Create a campaign from a template and an audience segment. It is created as a draft and sends nothing until the send endpoint is called.
विनंती मुख्य भाग
| नाव | प्रकार | आवश्यक | हे काय आहे |
|---|---|---|---|
name | string | होय | — |
template_id | string | होय | — |
segment_id | string | नाही | — |
channels | string<email, in_app, slack, telegram>[] | नाही | — |
scheduled_for | string | नाही | — |
include_not_in_good_standing | boolean | नाही | ⚖️ Suspended and unpaid organisations are excluded by default (CLAUDE.md §2.46); this is the explicit per-campaign override that makes a win-back campaign possible. The skip is… |
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 | नाही | — |
ही एंडपॉइंट परत करू शकेल अशा त्रुटी
401 · 403 · 422