POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione mail.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
mailServiceId (path) | Uuid | Sì | Email service ID (UUIDv7). |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
confirm | boolean | No | Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix". |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
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ì | — |
Errori che questo endpoint può restituire
401 · 403 · 404 · 409 · 422 · 429