Campaigns
POST /v1/campaigns
Create a campaign from a template and an audience.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your 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> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
name | string | Yes | — |
template_id | string | Yes | — |
segment_id | string | No | — |
channels | string<email, in_app, slack, telegram>[] | No | — |
scheduled_for | string | No | — |
include_not_in_good_standing | boolean | No | ⚖️ 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 | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
org_id | string | Yes | — |
name | string | Yes | — |
template_id | string | Yes | — |
segment_id | string | No | — |
purpose | string<marketing, transactional> | Yes | — |
channels | string[] | Yes | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Yes | — |
scheduled_for | string | No | — |
include_not_in_good_standing | boolean | No | — |
total_recipients | integer | Yes | — |
skipped | CampaignSkipCounts | Yes | ⛔ 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 | No | ⛔ `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 | No | — |
created_at | string | Yes | — |
started_at | string | No | — |
finished_at | string | No | — |
Errors this endpoint can return
401 · 403 · 422