Campaigns

POST `/v1/campaigns`

Create a campaign from a template and an audience.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

جہاں آپ کی تنظیم کی آئی ڈی آتی ہے

یہ اینڈ پوائنٹ JSON باڈی میں ایک فیلڈ کے طور پر org_id لیتا ہے۔

آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

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 پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو 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