mail

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

Edit an auto-reply.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 mail.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 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…
`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}