POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл 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 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