GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie mail.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
mailServiceId (path) | Uuid | Tak | Email service ID (UUIDv7). |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
domain | string | Tak | — |
healthy | boolean | Tak | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Tak | — |
dkim_ok | boolean | Tak | — |
dmarc_ok | boolean | Tak | — |
fixable | boolean | Tak | 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 | Tak | True when applying would replace published records, so confirm is required. |
existing_apex_mx | string[] | Tak | — |
foreign_mx | string[] | Tak | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Tak | — |
would_delete | string[] | Tak | 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 | Tak | — |
reason | string | Tak | Customer-grade English. Never a driver message. |
warnings | string[] | Tak | — |
live_mx | string[] | Tak | 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 | Tak | False when the public MX lookup failed. A failed lookup is never read as "action needed". |
mx_ok | boolean | Tak | Every live MX host is one this preset publishes, and there is at least one. |
action_needed | boolean | Tak | 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[] | Tak | The exact records to publish, as our preset would write them into a zone we host. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 429