mail

POST `/v1/mail/services/{mailServiceId}/mailboxes`

Create a mailbox.

身份验证

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

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

免费试用

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

curl -X POST https://api.zinndigital.com/v1/mail/services/{mailServiceId}/mailboxes \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "local": <string> }'

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

详细信息

Creates `local@domain` and returns it **with its password, once**. The password is never stored and cannot be read back — a lost one is replaced by `resetMailboxPassword`, not recovered. `password` is `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password; show that as "we could not display a password", never as a blank one. Requires `mail.manage`. Fails `409` on a duplicate address, and `422` when the service is not live yet or the domain is at its mailbox ceiling.

参数

名称	类型	必填	内容简介
`mailServiceId (path)`	`Uuid`	是	Email service ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`local`	`string`	是	The part before the `@`.
`send`	`boolean`	否	—
`receive`	`boolean`	否	—

响应

名称	类型	必填	内容简介
`mailbox`	`Mailbox`	是	One mailbox. Never carries a password — see `MailboxCreated`.
`password`	`object`	是	The password, shown once. `null` when the backend reconciled to a mailbox that already existed and refused to rotate a live password.

此端点可能返回的错误

401 · 403 · 404 · 409 · 422 · 429 · 503

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