Campaigns

POST `/v1/campaigns`

Create a campaign from a template and an audience.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Sehemu hii ya mwisho inachukua org_id kama uwanja katika mwili wa JSON.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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> }'

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`name`	`string`	Ndiyo	—
`template_id`	`string`	Ndiyo	—
`segment_id`	`string`	Hapana	—
`channels`	`string<email, in_app, slack, telegram>[]`	Hapana	—
`scheduled_for`	`string`	Hapana	—
`include_not_in_good_standing`	`boolean`	Hapana	⚖️ 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`	Hapana	—

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`id`	`string`	Ndiyo	—
`org_id`	`string`	Ndiyo	—
`name`	`string`	Ndiyo	—
`template_id`	`string`	Ndiyo	—
`segment_id`	`string`	Hapana	—
`purpose`	`string<marketing, transactional>`	Ndiyo	—
`channels`	`string[]`	Ndiyo	—
`status`	`string<draft, scheduled, sending, paused, sent, cancelled, failed>`	Ndiyo	—
`scheduled_for`	`string`	Hapana	—
`include_not_in_good_standing`	`boolean`	Hapana	—
`total_recipients`	`integer`	Ndiyo	—
`skipped`	`CampaignSkipCounts`	Ndiyo	⛔ 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`	Hapana	⛔ `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`	Hapana	—
`created_at`	`string`	Ndiyo	—
`started_at`	`string`	Hapana	—
`finished_at`	`string`	Hapana	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 422