POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie mail.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
mailServiceId (path) | Uuid | Ja | Email service ID (UUIDv7). |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
confirm | boolean | Nee | Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix". |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
domain | string | Ja | — |
healthy | boolean | Ja | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Ja | — |
dkim_ok | boolean | Ja | — |
dmarc_ok | boolean | Ja | — |
fixable | boolean | Ja | 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 | Ja | True when applying would replace published records, so `confirm` is required. |
existing_apex_mx | string[] | Ja | — |
foreign_mx | string[] | Ja | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Ja | — |
would_delete | string[] | Ja | 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 | Ja | — |
reason | string | Ja | Customer-grade English. Never a driver message. |
warnings | string[] | Ja | — |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 409 · 422 · 429