GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) mail.view 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 GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"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
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
mailServiceId (path) | Uuid | Igen | Email service ID (UUIDv7). |
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 ones… |
zone_unreadable | boolean | Igen | — |
reason | string | Igen | Customer-grade English. Never a driver message. |
warnings | string[] | Igen | — |
live_mx | string[] | Igen | The domain's MX hosts as PUBLIC DNS answers them right now (W43-09) - not our record of the zone. Empty when the domain publishes no MX, or when it could not be read (see… |
mx_readable | boolean | Igen | False when the public MX lookup failed. A failed lookup is never read as "action needed". |
mx_ok | boolean | Igen | Every live MX host is one this preset publishes, and there is at least one. |
action_needed | boolean | Igen | The customer's OWN DNS must change: we cannot publish to this zone and its live MX does not point where this preset sends mail. The panel then lists required_records with copy… |
required_records | object[] | Igen | The exact records to publish, as our preset would write them into a zone we host. |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 429