Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

更新邮件组

更新指定邮件组

请求说明

请求地址https://openapi.wps.cn/v7/mail_groups/{mail_group_id}/update
请求方法POST
签名方式KSO-1
权限要求查询和管理邮件组信息(用户授权) kso.mail_group.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
mail_group_idstring邮件组 id

请求体(Body)

名称参数类型是否必填说明
accepted_typestring[enum]邮件组可发信范围类型
all:所有人;company:当前企业所有人;member:邮件组内成员;custom:自定义
namestring名字
owner_addressstring邮件组负责人邮箱地址

请求地址示例

[POST] https://openapi.wps.cn/v7/mail_groups/{mail_group_id}/update

请求体示例

json
{
  "accepted_type": "string[enum]",
  "name": "string",
  "owner_address": "string"
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ accepted_sendersarray[object]允许往邮件组发信的成员列表,默认展示 10 条,allow_type 为 custom 时才有该字段
∟ ∟ avatarstring成员头像链接
∟ ∟ email_addressstring成员邮箱地址
∟ ∟ namestring成员名字
∟ ∟ typestring[enum]成员类型
dept:部门;user:用户;mailbox:公共邮箱
∟ accepted_typestring[enum]邮件组可发信范围类型
all:所有人;company:当前企业所有人;member:邮件组内成员;custom:自定义
∟ addressstring地址,形如:user_name@domain
∟ idstringid
∟ membersarray[object]邮件组成员列表,默认展示 10 条
∟ ∟ avatarstring成员头像链接
∟ ∟ email_addressstring成员邮箱地址
∟ ∟ namestring成员名字
∟ ∟ typestring[enum]成员类型
dept:部门;user:用户;mailbox:公共邮箱
∟ namestring名字
∟ ownerobject邮件组负责人
∟ ∟ avatarstring用户的头像链接
∟ ∟ email_addressstring用户的邮箱地址
∟ ∟ namestring名字。创建,更新公共邮箱时无需提供
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "accepted_senders": [
      {
        "avatar": "string",
        "email_address": "string",
        "name": "string",
        "type": "string[enum]"
      }
    ],
    "accepted_type": "string[enum]",
    "address": "string",
    "id": "string",
    "members": [
      {
        "avatar": "string",
        "email_address": "string",
        "name": "string",
        "type": "string[enum]"
      }
    ],
    "name": "string",
    "owner": {
      "avatar": "string",
      "email_address": "string",
      "name": "string"
    }
  },
  "msg": "string"
}
回到旧版