POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
mailServiceId (path) | Uuid | Igen | Email service ID (UUIDv7). |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
confirm | boolean | Nem | Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix". |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
domain | string | Igen | — |
healthy | boolean | Igen | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Igen | — |
dkim_ok | boolean | Igen | — |
dmarc_ok | boolean | Igen | — |
fixable | boolean | Igen | 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 | Igen | True when applying would replace published records, so `confirm` is required. |
existing_apex_mx | string[] | Igen | — |
foreign_mx | string[] | Igen | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Igen | — |
would_delete | string[] | Igen | 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 | Igen | — |
reason | string | Igen | Customer-grade English. Never a driver message. |
warnings | string[] | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 409 · 422 · 429