POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
認証
ベアラー トークンとして API キーを送信します。キーには mail.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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 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 · 409 · 422 · 429