zinn-campaigns
GET /v1/email-marketing/senders/{sender_id}/dns
Preview the sending records we would add to your DNS (when we host it).
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/senders/{sender_id}/dns \
-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. When the sending domain's DNS is served by us, lists exactly what applyEmailMarketingSenderDns would write: the provider's SPF include: merged into the SPF already there (your mechanisms and all are kept; two SPF records become one), a DMARC record only when none exists, and, for Zinn® sending, its DKIM key. An ESP's DKIM key lives at the ESP and is never written. A zone we do not serve (or one managed by an external app) answers writable: false with the reason in refusal.
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… |
sender_id (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
domain | string | Yes | — |
zone | string | Yes | — |
writable | boolean | Yes | Whether we serve this zone's DNS and can write it. |
refusal | object | Yes | Why it is not writable, as a catalogue key the dashboard renders. |
changes | EmailMarketingSenderDnsChange[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404