GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 mail.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
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.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
mailServiceId (path) | Uuid | 是 | Email service ID (UUIDv7). |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
domain | string | 是 | — |
healthy | boolean | 是 | All three mechanisms present and ours - nothing to publish. |
spf_ok | boolean | 是 | — |
dkim_ok | boolean | 是 | — |
dmarc_ok | boolean | 是 | — |
fixable | boolean | 是 | 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 | 是 | True when applying would replace published records, so confirm is required. |
existing_apex_mx | string[] | 是 | — |
foreign_mx | string[] | 是 | Apex MX targets that are not ours - the reason a fix is refused. |
foreign_spf_includes | string[] | 是 | — |
would_delete | string[] | 是 | 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 | 是 | — |
reason | string | 是 | Customer-grade English. Never a driver message. |
warnings | string[] | 是 | — |
live_mx | string[] | 是 | 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 | 是 | False when the public MX lookup failed. A failed lookup is never read as "action needed". |
mx_ok | boolean | 是 | Every live MX host is one this preset publishes, and there is at least one. |
action_needed | boolean | 是 | 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[] | 是 | The exact records to publish, as our preset would write them into a zone we host. |
此端点可能返回的错误
401 · 403 · 404 · 429