POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Pagpapatotoo
Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na mail.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
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> }'Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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`.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
mailServiceId (path) | Uuid | Oo | Email service ID (UUIDv7). |
Katawan ng kahilingan
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
local | string | Oo | The mailbox to auto-reply for. |
subject | string | Hindi | — |
content | string | Oo | — |
start_time | string | Hindi | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Hindi | RFC 3339, and must be after `start_time` when both are given. |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | string | Oo | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Oo | The part before the `@`. |
address | string | Oo | The mailbox this replies for. |
subject | string | Oo | — |
content | string | Oo | The reply body. |
start_time | string | Oo | 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 | Oo | When the auto-reply stops. `null` to run until switched off. |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 422 · 429 · 503