zinn-campaigns
GET /v1/email-marketing/campaigns/{campaign_id}/lint
Check a campaign's copy for deliverability problems before it is sent.
Authentication
Send an API key as a bearer token. The key must carry the email_marketing.view 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 GET https://api.zinndigital.com/v1/email-marketing/campaigns/{campaign_id}/lint \
-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.view. Rules only, run during the request, nothing billed: the subject (missing, too long, shouting, repeated punctuation, a fake Re:), the body (missing, tags mail clients strip, size over Gmail's clipping line, the image-to-text ratio, images without alt), every link (not http(s), an IP address, a public URL shortener, plain http, visible text naming a different domain than the link), the postal address the footer needs, and phrases spam filters score. Each finding is a stable code with a severity and params; the dashboard words it in the reader's language. The unsubscribe link and postal address are added to every message, so a body without them is not a finding.
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 |
|---|---|---|---|
campaign_id | string | Yes | — |
findings | EmailMarketingLintFinding[] | Yes | — |
errors | integer | Yes | — |
warnings | integer | Yes | — |
infos | integer | Yes | — |
Errors this endpoint can return
401 · 403 · 404