Campaigns
POST /v1/campaigns
Create a campaign from a template and an audience.
Tabbatar da Asali
Aiko da maɓallin API a matsayin bearer token. Wannan ma'anar ba ta bayyana takamaiman izini ba a cikin ƙayyadaddun bayanai, don haka ba wa maɓallin ku mafi ƙarancin abin da yake buƙata kuma ku bincika amsar maimakon yin zato.
Inda ID ɗin kungiyar ku ke zuwa
Wannan ma'ajiyar tana karɓar org_id a matsayin fili a cikin jikin JSON.
Ana samun lambar kungiyar ku a kan shafin maɓallan API a cikin madanninku, kusa da maɓallin kansa. Shi ne lambar da ta dace a kowane kiran da kuka yi.
Gwada
May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.
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> }'An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API
Bayani
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.
Jikin buƙata
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
name | string | Eh | — |
template_id | string | Eh | — |
segment_id | string | A'a | — |
channels | string<email, in_app, slack, telegram>[] | A'a | — |
scheduled_for | string | A'a | — |
include_not_in_good_standing | boolean | A'a | ⚖️ 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 | A'a | — |
Martani
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
id | string | Eh | — |
org_id | string | Eh | — |
name | string | Eh | — |
template_id | string | Eh | — |
segment_id | string | A'a | — |
purpose | string<marketing, transactional> | Eh | — |
channels | string[] | Eh | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Eh | — |
scheduled_for | string | A'a | — |
include_not_in_good_standing | boolean | A'a | — |
total_recipients | integer | Eh | — |
skipped | CampaignSkipCounts | Eh | ⛔ 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 | A'a | ⛔ `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 | A'a | — |
created_at | string | Eh | — |
started_at | string | A'a | — |
finished_at | string | A'a | — |
Kuskuren da wannan matsaya za ta iya maido wa
401 · 403 · 422