GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão mail.view; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
mailServiceId (path) | Uuid | Sim | Email service ID (UUIDv7). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
domain | string | Sim | — |
healthy | boolean | Sim | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Sim | — |
dkim_ok | boolean | Sim | — |
dmarc_ok | boolean | Sim | — |
fixable | boolean | Sim | 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 | Sim | True when applying would replace published records, so `confirm` is required. |
existing_apex_mx | string[] | Sim | — |
foreign_mx | string[] | Sim | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Sim | — |
would_delete | string[] | Sim | 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 | Sim | — |
reason | string | Sim | Customer-grade English. Never a driver message. |
warnings | string[] | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429