# 新增邮件组成员

批量新增邮件组成员,一次请求可以给一个邮件组添加多个成员

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/mail/v1/mailgroups/:email/members/batch_create
HTTP Method POST
支持的应用类型 自建应用
权限要求 [邮箱]-[创建/更改/查询邮件组]

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token
值格式:"Bearer access_token"
示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type string 固定值:"application/json; charset=utf-8"

# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)

名称 类型 描述
email string 邮件组地址 zenglinhong@kanzhun.com,需要带上邮箱后缀,邮箱地址格式错误会报错

# 查询参数(url后?&拼接的参数)

名称 类型 描述
user_id_type string 控制请求体内的用户 ID 的类型示例值:"open_id"
可选值有:
open_id:用户的 open id
union_id:用户的 union id
user_id:用户的 user id
默认值:open_id
当值为 user_id时,存在字段权限要求,未开通则会调用失败:
请参见[应用权限管理]-[通讯录]- [获取用户ID]

# 请求体

名称 类型 必填 描述
user_id_list string[] 添加邮件组成员,当有部分成员已存在时,仅会添加不存在的成员,当一个user_id填写错误时,接口整体报错添加失败;与email_list选填,两个都填写时将报错
email_list string[] 添加邮件组成员,当有部分成员已存在时,仅会添加不存在的成员,当一个user_id填写错误时,接口整体报错添加失败;与user_id_list选填,两个都填写时将报错;使用email_list时请user_id_type固定传email

# 请求体示例

{
  "user_id_list": ["qwerty","ytrewq"],
  "email_list": ["xxx@xxx.com","xxx2@xxx.com"]
}
1
2
3
4

# 响应

# 响应体

名称 类型 描述
code int 错误码,非 0 表示失败
msg string 调用描述
success boolean 调用是否成功
data object
 ∟invalid_user_ids string[] 不合法的 user_id 列表
 ∟invalid_emails string[] 不合法的邮箱地址
trace_id string 链路id

# 响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "success": true,
  "data": {
    "invalid_user_ids":["qweras"],
    "invalid_emails":["xxx@xxx.xx"]
  },
  "msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10

如果响应非成功状态,请对照 错误码文档

最后更新于 : 3/4/2024, 3:29:16 PM