mail

PATCH `/v1/mail/services/{mailServiceId}/responders/{responderId}`

Edit an auto-reply.

المصادقة

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

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

جربه الآن

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

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

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

التفاصيل

Changes the message and its schedule. The address is not part of this body — an auto-reply belongs to a mailbox, and the address is which mailbox you are editing rather than a property of the reply. ⭐ This used to say "the mail backend has no rename verb". That was false and was the stated premise of a decision to offer no rename at all; measured against the live upstream hosting API on 2026-08-16, a mailbox renames in place, same id, contents intact. Use renameMailbox to change an address, or a forwarder to give a mailbox a second one. The responder is returned as the backend reports it back after the write, not as it was sent: the mail backend answers an applied update and an ignored one with the same empty body, so echoing the request would be a fabricated success (D9256). Requires mail.manage.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`mailServiceId (path)`	`Uuid`	نعم	Email service ID (UUIDv7).
`responderId (path)`	`string`	نعم	The mail backend's identifier for the responder, as returned by the list — not a UUID of ours. A responder has no model here, so there is no id of ours to use.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`subject`	`string`	لا	—
`content`	`string`	نعم	—
`start_time`	`string`	لا	RFC 3339. `null` clears the schedule.
`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 a…
`end_time`	`string`	نعم	When the auto-reply stops. `null` to run until switched off.

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

401 · 403 · 404 · 422 · 429 · 503

PATCH /v1/mail/services/{mailServiceId}/responders/{responderId}