GET /v1/mail/services/{mailServiceId}/deliverability
SPF, DKIM and DMARC state for a domain that already has email.
אימות
שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה mail.view; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
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