GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation mail.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
mailServiceId (path) | Uuid | Oui | Email service ID (UUIDv7). |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
domain | string | Oui | — |
healthy | boolean | Oui | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Oui | — |
dkim_ok | boolean | Oui | — |
dmarc_ok | boolean | Oui | — |
fixable | boolean | Oui | 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 | Oui | True when applying would replace published records, so confirm is required. |
existing_apex_mx | string[] | Oui | — |
foreign_mx | string[] | Oui | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Oui | — |
would_delete | string[] | Oui | 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 ones… |
zone_unreadable | boolean | Oui | — |
reason | string | Oui | Customer-grade English. Never a driver message. |
warnings | string[] | Oui | — |
live_mx | string[] | Oui | The domain's MX hosts as PUBLIC DNS answers them right now (W43-09) - not our record of the zone. Empty when the domain publishes no MX, or when it could not be read (see… |
mx_readable | boolean | Oui | False when the public MX lookup failed. A failed lookup is never read as "action needed". |
mx_ok | boolean | Oui | Every live MX host is one this preset publishes, and there is at least one. |
action_needed | boolean | Oui | The customer's OWN DNS must change: we cannot publish to this zone and its live MX does not point where this preset sends mail. The panel then lists required_records with copy… |
required_records | object[] | Oui | The exact records to publish, as our preset would write them into a zone we host. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429