POST /v1/mail/services/{mailServiceId}/responders
Set an auto-reply on a mailbox.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Khóa này phải có quyền mail.manage; khóa không có quyền này sẽ bị từ chối với mã lỗi 403, không phải 404.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
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> }'Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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`.
Tham số
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
mailServiceId (path) | Uuid | Có | Email service ID (UUIDv7). |
Nội dung yêu cầu
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
local | string | Có | The mailbox to auto-reply for. |
subject | string | Không | — |
content | string | Có | — |
start_time | string | Không | RFC 3339. Omit or `null` for no schedule - see `MailResponder`. |
end_time | string | Không | RFC 3339, and must be after `start_time` when both are given. |
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
id | string | Có | The mail backend's identifier - the handle `DELETE` needs. |
local | string | Có | The part before the `@`. |
address | string | Có | The mailbox this replies for. |
subject | string | Có | — |
content | string | Có | The reply body. |
start_time | string | Có | 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 | Có | When the auto-reply stops. `null` to run until switched off. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 422 · 429 · 503