POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу mail.manage; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
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 конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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). |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
local | string | Да | The mailbox to auto-reply for. |
subject | string | Не | — |
content | string | Да | — |
start_time | string | Не | RFC 3339. Omit or null for no schedule - see MailResponder. |
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