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 కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ 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 one… |
zone_unreadable | boolean | అవును | — |
reason | string | అవును | Customer-grade English. Never a driver message. |
warnings | string[] | అవును | — |
ఈ ఎండ్పాయింట్ తిరిగి ఇవ్వగల లోపాలు
401 · 403 · 404 · 429