Campaigns
POST /v1/campaigns
Create a campaign from a template and an audience.
စစ်မှန်ကြောင်း အတည်ပြုခြင်း
API သော့တစ်ခုကို bearer token အဖြစ် ပေးပို့ပါ။ ဤ အမှတ်အသားအဆုံး (endpoint) သည် သတ်မှတ်ချက်တွင် တိကျသော ခွင့်ပြုချက်တစ်ခုကို မဖော်ပြထားပါသဖြင့်၊ သင့်သော့ကို အနည်းဆုံး လိုအပ်သည်များသာ ပေးအပ်ပြီး မူလအခြေအနေကို ယူဆမည့်အစား တုံ့ပြန်မှုကို စစ်ဆေးပါ။
သင့်အဖွဲ့အစည်း၏ id ထည့်သွင်းရမည့်နေရာ
ဤအစွန်းဆုံးနေရာသည် JSON ခန္ဓာကိုယ်အတွင်းရှိ ကွင်းတစ်ခုအနေဖြင့် org_id ကို ယူပါသည်။
သင့်အဖွဲ့အစည်း id သည် သင်၏ ဒက်ရှ်ဘုတ်ရှိ API သော့များ မျက်နှာပြင်တွင်၊ သော့၏ ဘေး၌ ရှိပါသည်။ ၎င်းသည် သင်ပြုလုပ်သည့် ခေါ်ဆိုမှုတိုင်းတွင် တူညီသော id ဖြစ်ပါသည်။
စမ်းကြည့်ရန်
ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် 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 ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို 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 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 | မဟုတ်ပါ | — |
ဤအမှတ်ဆက်မှ ပြန်ပေးနိုင်သော အမှားများ
401 · 403 · 422