mail

PATCH `/v1/mail/routing/{fqdn}`

Re-point a forwarding domain's catch-all.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن mail.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PATCH https://api.zinndigital.com/v1/mail/routing/{fqdn} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "destination": <string> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Sets where everything addressed to this domain is delivered. Requires mail.manage. ⛔ Taking ownership is part of the write. The alias stops being system-managed, so the convergence sweep will never reassert our computed destination over the customer's choice — silently, which is the only way that failure would ever be noticed. ⛔ Refused with 422 on a domain that stores its mail in mailboxes, rather than accepted and ignored: a forwarding address on a mailbox domain is a control that appears to work while mail keeps arriving in the mailbox.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`fqdn (path)`	`string`	نعم	The hostname whose mail routing is being read or changed.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`destination`	`string`	نعم	Where mail to any address on this domain is delivered.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`fqdn`	`string`	نعم	The domain this routing is for.
`mechanism`	`string<zinn_mailbox, zinn_forward, cloudflare_routing, external, none>`	نعم	Which mechanism serves this domain's inbound mail. `zinn_mailbox` stores it; `zinn_forward` and `cloudflare_routing` pass it on and store nothing; `external` means the customer's…
`mechanism_label`	`string`	نعم	Why this mechanism was chosen, in a sentence a person can act on.
`forwards`	`boolean`	نعم	Whether mail is passed on rather than stored.
`stores`	`boolean`	نعم	Whether this domain has real mailboxes on our relay.
`status`	`string<pending, converged, held, failed>`	نعم	The last convergence pass's outcome. `held` is distinct from `failed` and means the zone could not be read, so nothing was changed — which is correct behaviour, not a fault.
`dns_authority`	`string<cloudflare, other, unknown>`	نعم	Whose nameservers the zone was delegated to when last measured. `unknown` means the lookup did not answer — never that it is delegated elsewhere.
`catch_all`	`string`	نعم	Where mail to any address on this domain is delivered. Empty when no forwarding alias exists — a domain with no deliverable destination gets no alias rather than one pointing…
`last_converged_at`	`string`	لا	When the world last agreed with the intended state.

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429

PATCH /v1/mail/routing/{fqdn}