zinn-campaigns
POST /v1/email-marketing/campaigns/{campaign_id}/send
Start sending a campaign to its list.
Authentication
Send an API key as a bearer token. The key must carry the email_marketing.manage permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.
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/email-marketing/campaigns/{campaign_id}/send \
-H "Authorization: Bearer zdk_live_…"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
Gated on email_marketing.manage. The abuse gate runs first, in order: the line is open, the account is in good standing, the plan includes e-mail, the campaign is complete, the sending connection is verified (Zinn® sending is refused while it warms up), the From domain publishes SPF and DMARC, sending is not paused, someone on the list may be mailed, the plan's monthly e-mails cover the list, and staff have reviewed an account above the monthly review line. Each refusal is its own 409 code. On 202 a durable workflow sends in batches; a new sender's daily volume ramps up with clean sending days, and a bounce or complaint rate over the line pauses the account's sending.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | The organization this call acts on. Optional for a caller with exactly one direct membership; required for anyone with more than one — which is every reseller and every agency… |
campaign_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
list_id | string | Yes | — |
sender_id | string | Yes | — |
from_name | string | Yes | — |
reply_to | string | Yes | — |
subject | string | Yes | — |
preheader | string | Yes | — |
html | string | Yes | — |
text | string | Yes | — |
template | string<basic, raw> | Yes | — |
postal_address | string | Yes | — |
status | string<draft, sending, paused, sent, refused> | Yes | — |
refusal_code | string<not_open, account_on_hold, not_included, incomplete, pool_warming, sender_unverified, domain_auth, paused, quota, review, empty> | Yes | — |
refusal_message | string | Yes | — |
recipients_total | integer | Yes | — |
started_at | string | Yes | — |
finished_at | string | Yes | — |
created_at | string | Yes | — |
updated_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 409