mail

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

Set an auto-reply on a mailbox.

المصادقة

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

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

جربه الآن

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

curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/responders \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "local": <string>, "content": <string> }'

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

التفاصيل

Idempotent on `local`: re-posting for the same mailbox reconciles to the existing responder rather than creating a second one, which is the backend's own natural key. Requires `mail.manage`.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`mailServiceId (path)`	`Uuid`	نعم	Email service ID (UUIDv7).

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`local`	`string`	نعم	The mailbox to auto-reply for.
`subject`	`string`	لا	—
`content`	`string`	نعم	—
`start_time`	`string`	لا	RFC 3339. Omit or `null` for no schedule - see `MailResponder`.
`end_time`	`string`	لا	RFC 3339, and must be after `start_time` when both are given.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`string`	نعم	The mail backend's identifier - the handle `DELETE` needs.
`local`	`string`	نعم	The part before the `@`.
`address`	`string`	نعم	The mailbox this replies for.
`subject`	`string`	نعم	—
`content`	`string`	نعم	The reply body.
`start_time`	`string`	نعم	When the auto-reply starts. `null` when unscheduled (it replies from now on). ⭐ This used to be declared "Opaque - do not parse, compare or render as a date" (#664), out of…
`end_time`	`string`	نعم	When the auto-reply stops. `null` to run until switched off.

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

401 · 403 · 404 · 422 · 429 · 503

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