Campaigns
POST /v1/campaigns
Create a campaign from a template and an audience.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Kung saan mapupunta ang id ng iyong organisasyon
Ang endpoint na ito ay kumukuha ng org_id bilang isang field sa JSON body.
Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
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> }'Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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.
Katawan ng kahilingan
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
name | string | Oo | — |
template_id | string | Oo | — |
segment_id | string | Hindi | — |
channels | string<email, in_app, slack, telegram>[] | Hindi | — |
scheduled_for | string | Hindi | — |
include_not_in_good_standing | boolean | Hindi | ⚖️ 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 | Hindi | — |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | string | Oo | — |
org_id | string | Oo | — |
name | string | Oo | — |
template_id | string | Oo | — |
segment_id | string | Hindi | — |
purpose | string<marketing, transactional> | Oo | — |
channels | string[] | Oo | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Oo | — |
scheduled_for | string | Hindi | — |
include_not_in_good_standing | boolean | Hindi | — |
total_recipients | integer | Oo | — |
skipped | CampaignSkipCounts | Oo | ⛔ 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 | Hindi | ⛔ `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 | Hindi | — |
created_at | string | Oo | — |
started_at | string | Hindi | — |
finished_at | string | Hindi | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 422