GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Autenticación
Envía una clave de API como token de portador. La clave debe tener el permiso mail.view; una clave que no lo tenga se rechazará con un código 403, no 404.
Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.
Pruébalo
Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API
Detalles
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`.
Parámetros
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
mailServiceId (path) | Uuid | Sí | Email service ID (UUIDv7). |
Respuesta
| Nombre | Tipo | Obligatorio | ¿Qué es esto? |
|---|---|---|---|
domain | string | Sí | — |
healthy | boolean | Sí | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Sí | — |
dkim_ok | boolean | Sí | — |
dmarc_ok | boolean | Sí | — |
fixable | boolean | Sí | 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 | Sí | True when applying would replace published records, so `confirm` is required. |
existing_apex_mx | string[] | Sí | — |
foreign_mx | string[] | Sí | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Sí | — |
would_delete | string[] | Sí | 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 | Sí | — |
reason | string | Sí | Customer-grade English. Never a driver message. |
warnings | string[] | Sí | — |
Errores que este endpoint puede devolver
401 · 403 · 404 · 429