mail

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

Edit an auto-reply.

אימות

שלחו מפתח API כאסימון נושא (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 בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-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}