mail

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

Publish this domain's mail records.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (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

التفاصيل

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