mail

POST `/v1/mail/services/{mailServiceId}/deliverability`

Publish this domain's mail records.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 mail.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Write the correct SPF, DKIM and DMARC records into the domain's zone. ⛔ Refuses with `422` when the apex MX is somebody else's - that is not a state to confirm past from this screen, because the customer's mail is being delivered today and this button must never be how that stops. When records would be **replaced**, answers `409` until `confirm: true` is sent, so a destructive apply is always a deliberate second act (the confirm-gated shape #622 forced on DNS). Requires `mail.manage`.

参数

名称	类型	必填	内容简介
`mailServiceId (path)`	`Uuid`	是	Email service ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`confirm`	`boolean`	否	Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix".

响应

名称	类型	必填	内容简介
`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 one…
`zone_unreadable`	`boolean`	是	—
`reason`	`string`	是	Customer-grade English. Never a driver message.
`warnings`	`string[]`	是	—

此端点可能返回的错误

401 · 403 · 404 · 409 · 422 · 429

POST /v1/mail/services/{mailServiceId}/deliverability