批量删除公共邮箱成员
一次请求可以删除一个公共邮箱中的多个成员。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/mail/v1/public_mailboxes/:public_mailbox_id/members/batch_delete |
| HTTP Method | DELETE |
| 接口频率限制 | 20 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | mail:public_mailbox 查询、创建、修改公共邮箱 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
public_mailbox_id | string | The unique ID or email address of a public mailbox 示例值:"xxxxxxxxxxxxxxx or test_public_mailbox@xxx.xx" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
member_id_list | string\[\] | 是 | 本次调用删除的公共邮箱成员ID列表 示例值:["xxxxxxxxxxxxxxx"] 数据校验规则: - 长度范围: 1 ~ 200 |
请求体示例
json
{
"member_id_list": [
"xxxxxxxxxxxxxxx"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 404 | 1234016 | public mailbox not found | 请确认公共邮箱是否存在 |
| 404 | 1234040 | public mailbox member not found | 请确认公共邮箱成员是否存在 |
