POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Pengesahan
Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran mail.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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`.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
mailServiceId (path) | Uuid | Ya | Email service ID (UUIDv7). |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
confirm | boolean | Tidak | Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix". |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
domain | string | Ya | — |
healthy | boolean | Ya | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Ya | — |
dkim_ok | boolean | Ya | — |
dmarc_ok | boolean | Ya | — |
fixable | boolean | Ya | 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 | Ya | True when applying would replace published records, so `confirm` is required. |
existing_apex_mx | string[] | Ya | — |
foreign_mx | string[] | Ya | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Ya | — |
would_delete | string[] | Ya | 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 | Ya | — |
reason | string | Ya | Customer-grade English. Never a driver message. |
warnings | string[] | Ya | — |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 409 · 422 · 429