mail

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

Publish this domain's mail records.

כל נקודות הקצה מסוג mail

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה mail.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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).

גוף הבקשה

שםסוגנדרשמה זה
confirmbooleanלאRequired when `needs_confirmation` is true. Defaults to false so a destructive apply is never a side effect of clicking "fix".

תשובה

שםסוגנדרשמה זה
domainstringכן
healthybooleanכןAll three mechanisms present and ours - nothing to publish.
spf_okbooleanכן
dkim_okbooleanכן
dmarc_okbooleanכן
fixablebooleanכן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_confirmationbooleanכןTrue when applying would replace published records, so `confirm` is required.
existing_apex_mxstring[]כן
foreign_mxstring[]כןApex MX targets that are not ours - the reason a fix is refused.
foreign_spf_includesstring[]כן
would_deletestring[]כן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_unreadablebooleanכן
reasonstringכןCustomer-grade English. Never a driver message.
warningsstring[]כן

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 409 · 422 · 429