mail

POST /v1/mail/services/{mailServiceId}/forwarders

Forward an address, a catch-all, or a whole domain.

所有 mail 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 mail.manage 权限;缺少该权限的密钥将被拒绝并返回 403 状态码,而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

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[]> }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

`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`.

参数

名称类型必填内容简介
mailServiceId (path)UuidEmail service ID (UUIDv7).

请求正文

名称类型必填内容简介
sourcestringRequired for `mailbox`; ignored for `catchall`/`wildcard`.
targetsstring[]
kindMailForwarderKind`mailbox` forwards one address; `catchall` takes anything not otherwise matched at the domain; `wildcard` forwards the whole domain to another one.

响应

名称类型必填内容简介
idstringThe mail backend's identifier.
sourcestringThe local part being forwarded for `mailbox`; the domain itself for `catchall`/`wildcard`.
targetsstring[]Where mail goes. May include the backend's reserved drop/reject targets.
kindMailForwarderKind`mailbox` forwards one address; `catchall` takes anything not otherwise matched at the domain; `wildcard` forwards the whole domain to another one.

此端点可能返回的错误

401 · 403 · 404 · 422 · 429 · 503