mail

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

Edit an auto-reply.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز 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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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}