POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
Նույնականացում
Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա 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 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