Campaigns
POST /v1/campaigns/{campaignId}/send
Start the durable send.
Authentication
Send an API key as a bearer token. The endpoint checks campaigns.send; a key without it is refused with 403, not 404.
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/{campaignId}/send \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
Returns immediately; the send runs as a Temporal workflow that resumes rather than truncating. A send above the confirmation threshold requires confirm to equal the campaign's name exactly — enforced here, because a control that lives only in the client is one an API call walks past.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
campaignId (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
confirm | string | No | — |
org_id | string | No | — |
scheduled_for | string | No | docs/1000 §3 — send later: a time zone-aware moment more than 2 minutes and at most 90 days ahead. The campaign reads scheduled until then (Temporal holds the delay); cancelling… |
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 these,… |
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 · 404 · 409 · 422