mail

POST `/v1/mail/services/{mailServiceId}/deliverability`

Publish this domain's mail records.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास 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`.

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`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

POST /v1/mail/services/{mailServiceId}/deliverability