POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Кілтте mail.manage рұқсаты болуы тиіс; онсыз кілтке 404 емес, 403 қатесі қайтарылады.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
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`.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
mailServiceId (path) | Uuid | Иә | Email service ID (UUIDv7). |
Сұрау денесі
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
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