Campaigns
POST /v1/campaigns
Create a campaign from a template and an audience.
Նույնականացում
Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:
Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն
Այս վերջնակետը JSON մարմնում որպես դաշտ վերցնում է org_id-ը։
Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
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-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը 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