POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na mail.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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`.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
mailServiceId (path) | Uuid | Oo | Email service ID (UUIDv7). |
Katawan ng kahilingan
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
confirm | boolean | Hindi | Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix". |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
domain | string | Oo | — |
healthy | boolean | Oo | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Oo | — |
dkim_ok | boolean | Oo | — |
dmarc_ok | boolean | Oo | — |
fixable | boolean | Oo | 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 | Oo | True when applying would replace published records, so `confirm` is required. |
existing_apex_mx | string[] | Oo | — |
foreign_mx | string[] | Oo | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Oo | — |
would_delete | string[] | Oo | 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 | Oo | — |
reason | string | Oo | Customer-grade English. Never a driver message. |
warnings | string[] | Oo | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 409 · 422 · 429