POST /v1/mail/services/{mailServiceId}/forwarders
Forward an address, a catch-all, or a whole domain.
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}/forwarders \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "targets": <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
source is required for mailbox and ignored for catchall/wildcard, where the whole domain is the source — so it may be omitted for those rather than sending a value the backend discards. 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ì |
|---|---|---|---|
source | string | Không | Required for mailbox; ignored for catchall/wildcard. |
targets | string[] | Có | — |
kind | MailForwarderKind | Không | mailbox forwards one address; catchall takes anything not otherwise matched at the domain; wildcard forwards the whole domain to another one. |
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. |
source | string | Có | The local part being forwarded for mailbox; the domain itself for catchall/wildcard. |
targets | string[] | Có | Where mail goes. May include the backend's reserved drop/reject targets. |
kind | MailForwarderKind | Có | mailbox forwards one address; catchall takes anything not otherwise matched at the domain; wildcard forwards the whole domain to another one. |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404 · 422 · 429 · 503