POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте mail.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
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`.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
mailServiceId (path) | Uuid | Иә | Email service ID (UUIDv7). |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
confirm | boolean | Жоқ | Required when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix". |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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