更新邮件群组 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

快速入门服务端API 客户端API 附录更新日志联系我们

企业内部开发服务端API 邮件管理邮件群组更新邮件群组

更新邮件群组

最后更新：2022/12/01

该接口用于更新邮件群组，可以修改群组名称、群组成员、群组使用权限等。需要注意的是Json数组类型传空值将会清空其内容，不传则保持不变。
例如清空email_list:

{
  "groupid": "zhangsangroup@gzdev.com",
  "groupname": "zhangsangroup",
  "email_list" : {"list" : []}
  // 省略
}

若需保持不变则不传即可:

{
  "groupid": "zhangsangroup@gzdev.com",
  "groupname": "zhangsangroup"
  // 省略
}

请求方式：POST（HTTPS）
请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/group/update?access_token=ACCESS_TOKEN

请求包体

{
  "groupid": "zhangsangroup@gzdev.com",
  "groupname": "zhangsangroup",
  "email_list": {
    "list": ["lisi@gzdev.com", "wangwu@gzdev.com"]
  },
  "tag_list": {
    "list": [2, 5]
  },
  "department_list": {
    "list": [1, 2]
  },
  "group_list": {
    "list": ["aaa@gzdev.com"]
  },
  "allow_type": 3,
  "allow_emaillist": {
    "list": ["zhangsanp@gzdev.com"]
  },
  "allow_departmentlist": {
    "list": [1, 2]
  },
  "allow_taglist": {
    "list": [1, 3]
  }
}

参数说明

参数	类型	是否必须	说明
groupid	string	是	邮件群组ID，邮箱格式
groupname	string	否	邮件群组名称，不能与其他群组重名，长度限定64字节
email_list	string	否	群组内成员邮箱地址，读取成员的biz_mail字段，不传则不变，传空则清空。成员由email_list，group_list，department_list，tag_list共同组成，不允许全部清空
tag_list	uint32	否	群组内包含的标签ID，不传则不变，传空为清空
department_list	uint32	否	群组内包含的部门ID，不传则不变，传空为清空
group_list	string	否	群组内包含的群组邮箱ID，不传则不变，传空为清空
allow_type	uint32	否	群组使用权限。0: 企业成员, 1任何人， 2:组内成员，3:自定义成员。当值为0、1、2时，不得传入allow_emaillist，allow_departmentlist，allow_taglist。当值为3时，必须传入allow_emaillist，allow_departmentlist，allow_taglist至少一项。若不需更新则不传入参数。
allow_emaillist	string	否	允许使用群组群发的成员邮箱地址，不传则不变，传空为清空
allow_departmentlist	uint32	否	允许使用群组群发的部门ID，不传则不变，传空为清空
allow_taglist	uint32	否	允许使用群组群发的标签ID，不传则不变，传空为清空

权限说明

自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用（accesstoken如何获取？）
应用调用接口只能访问自身创建的邮件群组

返回示例

{
   "errcode": 0,
   "errmsg": "ok"
}

参数说明

参数	类型	说明
errcode	int32	错误码
errmsg	string	错误码说明

创建邮件群组

删除邮件群组

本节内容

更新邮件群组