Campaigns
POST /v1/campaigns
Create a campaign from a template and an audience.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.
Ku shkon id i organizatës suaj
Ky endpoint pranon org_id si fushë në trupin JSON.
ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
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> }'Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
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.
Trupi i kërkesës
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
name | string | Po | — |
template_id | string | Po | — |
segment_id | string | Jo | — |
channels | string<email, in_app, slack, telegram>[] | Jo | — |
scheduled_for | string | Jo | — |
include_not_in_good_standing | boolean | Jo | ⚖️ 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 | Jo | — |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
id | string | Po | — |
org_id | string | Po | — |
name | string | Po | — |
template_id | string | Po | — |
segment_id | string | Jo | — |
purpose | string<marketing, transactional> | Po | — |
channels | string[] | Po | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Po | — |
scheduled_for | string | Jo | — |
include_not_in_good_standing | boolean | Jo | — |
total_recipients | integer | Po | — |
skipped | CampaignSkipCounts | Po | ⛔ 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 | Jo | ⛔ `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 | Jo | — |
created_at | string | Po | — |
started_at | string | Jo | — |
finished_at | string | Jo | — |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 422