GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie mail.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de 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
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
mailServiceId (path) | Uuid | Ja | Email service ID (UUIDv7). |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
domain | string | Ja | — |
healthy | boolean | Ja | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Ja | — |
dkim_ok | boolean | Ja | — |
dmarc_ok | boolean | Ja | — |
fixable | boolean | Ja | 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 | Ja | True when applying would replace published records, so `confirm` is required. |
existing_apex_mx | string[] | Ja | — |
foreign_mx | string[] | Ja | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Ja | — |
would_delete | string[] | Ja | 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 | Ja | — |
reason | string | Ja | Customer-grade English. Never a driver message. |
warnings | string[] | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 429