GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास mail.view अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
curl -X GET https://api.zinndigital.com/v1/mail/services/{mailServiceId}/deliverability \
-H "Authorization: Bearer zdk_live_…"साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
विवरण
Whether this domain's mail is set up to be delivered - the question a customer asks when their messages land in spam. ⛔ A different question from /preflight, which asks what setting mail up here would destroy; both read the same underlying report so a preview and the fix cannot disagree. fixable is false when the apex MX belongs to somebody else or the zone cannot be read, because a one-click apply would then either destroy working mail or write blind. Requires mail.view.
पैरामीटर
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
mailServiceId (path) | Uuid | हाँ | Email service ID (UUIDv7). |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
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 · 429