mail

PATCH `/v1/mail/routing/{fqdn}`

Re-point a forwarding domain's catch-all.

所有 mail 端点

所有开发者文档 →

身份验证

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

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

免费试用

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

curl -X PATCH https://api.zinndigital.com/v1/mail/routing/{fqdn} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "destination": <string> }'

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

详细信息

Sets where everything addressed to this domain is delivered. Requires mail.manage. ⛔ Taking ownership is part of the write. The alias stops being system-managed, so the convergence sweep will never reassert our computed destination over the customer's choice — silently, which is the only way that failure would ever be noticed. ⛔ Refused with 422 on a domain that stores its mail in mailboxes, rather than accepted and ignored: a forwarding address on a mailbox domain is a control that appears to work while mail keeps arriving in the mailbox.

参数

名称	类型	必填	内容简介
`fqdn (path)`	`string`	是	The hostname whose mail routing is being read or changed.

请求正文

名称	类型	必填	内容简介
`destination`	`string`	是	Where mail to any address on this domain is delivered.

响应

名称	类型	必填	内容简介
`fqdn`	`string`	是	The domain this routing is for.
`mechanism`	`string<zinn_mailbox, zinn_forward, cloudflare_routing, external, none>`	是	Which mechanism serves this domain's inbound mail. `zinn_mailbox` stores it; `zinn_forward` and `cloudflare_routing` pass it on and store nothing; `external` means the customer's…
`mechanism_label`	`string`	是	Why this mechanism was chosen, in a sentence a person can act on.
`forwards`	`boolean`	是	Whether mail is passed on rather than stored.
`stores`	`boolean`	是	Whether this domain has real mailboxes on our relay.
`status`	`string<pending, converged, held, failed>`	是	The last convergence pass's outcome. `held` is distinct from `failed` and means the zone could not be read, so nothing was changed — which is correct behaviour, not a fault.
`dns_authority`	`string<cloudflare, other, unknown>`	是	Whose nameservers the zone was delegated to when last measured. `unknown` means the lookup did not answer — never that it is delegated elsewhere.
`catch_all`	`string`	是	Where mail to any address on this domain is delivered. Empty when no forwarding alias exists — a domain with no deliverable destination gets no alias rather than one pointing…
`last_converged_at`	`string`	否	When the world last agreed with the intended state.

此端点可能返回的错误

401 · 403 · 404 · 422 · 429

PATCH /v1/mail/routing/{fqdn}