GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin mail.view; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
Whether this domain's mail is set up to be **delivered** - the question a customer asks when their messages land in spam. ⛔ A different question from `/preflight`, which asks what setting mail up here would destroy; both read the same underlying report so a preview and the fix cannot disagree. `fixable` is false when the apex MX belongs to somebody else or the zone cannot be read, because a one-click apply would then either destroy working mail or write blind. Requires `mail.view`.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
mailServiceId (path) | Uuid | Ya | Email service ID (UUIDv7). |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
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 | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 429