zinn-campaigns
POST /v1/email-marketing/ai/write
Write a draft campaign email from a short brief with Zinn® AI.
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/ai/write \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "brief": <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
Gated on email_marketing.manage. One model call during the request, paid by the organisation's own provider key, its credit balance or its included AI allowance, and listed on the AI spend page as "Writing campaign emails". Returns two subject lines (for an A/B test), a preheader and a sanitised HTML body in the requested language; nothing is saved, the editor fills the campaign and the customer saves it. Refused with 402 while the account is on hold or there is no AI allowance left, and 422 with a failure object (provider outage, a problem with the customer's own key, or ours) when the model call fails. Nothing is charged for a failed call.
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… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
brief | string | Yes | What the email is about |
locale | string | No | The language to write in (a BCP 47 tag); defaults to en. |
tone | string<friendly, professional, playful, urgent, calm> | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
subject_a | string | Yes | — |
subject_b | string | Yes | A second subject line for an A/B test. |
preheader | string | Yes | — |
html | string | Yes | The body |
model | string | Yes | — |
Errors this endpoint can return
401 · 402 · 403 · 404 · 409 · 422