GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung mail.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
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`.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
mailServiceId (path) | Uuid | Ja | Email service ID (UUIDv7). |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
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 | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 429