POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão mail.manage; 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 POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
Write the correct SPF, DKIM and DMARC records into the domain's zone. ⛔ Refuses with `422` when the apex MX is somebody else's - that is not a state to confirm past from this screen, because the customer's mail is being delivered today and this button must never be how that stops. When records would be **replaced**, answers `409` until `confirm: true` is sent, so a destructive apply is always a deliberate second act (the confirm-gated shape #622 forced on DNS). Requires `mail.manage`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
mailServiceId (path) | Uuid | Sim | Email service ID (UUIDv7). |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
confirm | boolean | Não | Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix". |
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 · 409 · 422 · 429