POST /v1/mail/services/{mailServiceId}/deliverability
Publish this domain's mail records.
تصدیقهویت
یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د 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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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