# 删除公共邮箱使用人
用于批量删除公共邮箱可用用户
# 请求
| 基本 | |
|---|---|
| HTTP URL | https://hi-gw.weizhipin.com/open-apis/mail/v1/public_mailboxes/:public_mailbox_id/members |
| HTTP Method | DELETE |
| 支持的应用类型 | 自建应用 |
| 权限要求 | [邮箱]-[创建/更改/查询公共邮箱] |
# 请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式："Bearer access_token"示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" |
| Content-Type | string | 是 | 固定值："application/json; charset=utf-8" |
# 路径参数（url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值）
| 名称 | 类型 | 描述 |
|---|---|---|
| public_mailbox_id | string | 公共邮箱地址，需要带上邮箱后缀 邮箱地址格式错误/不为公共邮箱会报错 |
# 查询参数（url后?&拼接的参数）
| 名称 | 类型 | 描述 |
|---|---|---|
| user_id_type | string | 用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id，字段权限要求： 获取用户 user ID |
# 请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| user_id_list | string[] | 否 | 删除使用人，当有部分使用人不存在时，仅会删除存在的使用人 当一个user_id填写错误时，接口整体报错删除失败 |
# 请求体示例
{
"user_id_list": [
"123"
]
}
1
2
3
4
5
2
3
4
5
# 响应
# 响应体
| 名称 | 类型 | 描述 |
|---|---|---|
| code | int | 错误码，非 0 表示失败 |
| msg | string | 错误描述 |
| data | - | - |
| ∟invalid_user_ids | string[] | 不合法的 user_id 列表 |
| trace_id | string | 链路id |
# 响应体示例
{
"code": 0,
"traceId": "_Ao59UOIBLPCeAAu",
"success": true,
"data": {
"invalid_user_ids": [
"123"
]
},
"msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
如果响应非成功状态，请对照 错误码文档