GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Authentication
Send an API key as a bearer token. The key must carry the mail.view permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
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/mail/services/{mailServiceId}/deliverability \
-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
Whether this domain's mail is set up to be **delivered** - the question a customer asks when their messages land in spam. ⛔ A different question from `/preflight`, which asks what setting mail up here would destroy; both read the same underlying report so a preview and the fix cannot disagree. `fixable` is false when the apex MX belongs to somebody else or the zone cannot be read, because a one-click apply would then either destroy working mail or write blind. Requires `mail.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
mailServiceId (path) | Uuid | Yes | Email service ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
domain | string | Yes | — |
healthy | boolean | Yes | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Yes | — |
dkim_ok | boolean | Yes | — |
dmarc_ok | boolean | Yes | — |
fixable | boolean | Yes | Whether a one-click apply is offered. **False** over a foreign apex MX or an unreadable zone - the panel shows the reason instead of a button. |
needs_confirmation | boolean | Yes | True when applying would replace published records, so `confirm` is required. |
existing_apex_mx | string[] | Yes | — |
foreign_mx | string[] | Yes | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Yes | — |
would_delete | string[] | Yes | Records an apply would remove or replace, as `NAME TYPE VALUE`. Listed verbatim rather than counted: a customer must not be able to destroy mail records without seeing which one… |
zone_unreadable | boolean | Yes | — |
reason | string | Yes | Customer-grade English. Never a driver message. |
warnings | string[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429