mail

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

Set an auto-reply on a mailbox.

Усі кінцеві точки mail

Автентифікація

Надішліть ключ API як маркер носія (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 у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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).

Тіло запиту

НазваТипОбов'язковеЩо це таке
localstringТакThe mailbox to auto-reply for.
subjectstringНі
contentstringТак
start_timestringНіRFC 3339. Omit or `null` for no schedule - see `MailResponder`.
end_timestringНіRFC 3339, and must be after `start_time` when both are given.

Відповідь

НазваТипОбов'язковеЩо це таке
idstringТакThe mail backend's identifier - the handle `DELETE` needs.
localstringТакThe part before the `@`.
addressstringТакThe mailbox this replies for.
subjectstringТак
contentstringТакThe reply body.
start_timestringТак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_timestringТакWhen the auto-reply stops. `null` to run until switched off.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422 · 429 · 503