GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
Autentizace
Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění mail.view; klíč bez něj je odmítnut s kódem 403, nikoli 404.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
mailServiceId (path) | Uuid | Ano | Email service ID (UUIDv7). |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
domain | string | Ano | — |
healthy | boolean | Ano | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | Ano | — |
dkim_ok | boolean | Ano | — |
dmarc_ok | boolean | Ano | — |
fixable | boolean | Ano | 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 | Ano | True when applying would replace published records, so confirm is required. |
existing_apex_mx | string[] | Ano | — |
foreign_mx | string[] | Ano | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | Ano | — |
would_delete | string[] | Ano | 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 | Ano | — |
reason | string | Ano | Customer-grade English. Never a driver message. |
warnings | string[] | Ano | — |
live_mx | string[] | Ano | 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 | Ano | False when the public MX lookup failed. A failed lookup is never read as "action needed". |
mx_ok | boolean | Ano | Every live MX host is one this preset publishes, and there is at least one. |
action_needed | boolean | Ano | 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[] | Ano | The exact records to publish, as our preset would write them into a zone we host. |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404 · 429