POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin mail.manage; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
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> }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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`.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
mailServiceId (path) | Uuid | Ya | Email service ID (UUIDv7). |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
local | string | Ya | The mailbox to auto-reply for. |
subject | string | Tidak | — |
content | string | Ya | — |
start_time | string | Tidak | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Tidak | RFC 3339, and must be after `start_time` when both are given. |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | string | Ya | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Ya | The part before the `@`. |
address | string | Ya | The mailbox this replies for. |
subject | string | Ya | — |
content | string | Ya | The reply body. |
start_time | string | Ya | 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 | Ya | When the auto-reply stops. `null` to run until switched off. |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422 · 429 · 503