POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز mail.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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