批量添加公共邮箱成员

POST

https://open.feishu.cn/open-apis/mail/v1/public_mailboxes/{public_mailbox_id}/members/batch_create

一次请求可以给一个公共邮箱添加多个成员。

错误码

HTTP状态码	错误码	描述	排查建议
404	1234016	public mailbox not found	请确认公共邮箱是否存在
400	1234008	request parameter error	请检查请求参数是否正确
400	1234027	some users have exceeded the limit on the number of bindable public mailboxes	请检查并去除绑定公共邮箱已达数量限制的用户

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/mail/v1/public_mailboxes//members/batch_create?user_id_type=' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "items": [
        {
            "user_id": "xxxxxxxxxx",
            "type": "USER"
        }
    ]
}'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "items": [
      {
        "member_id": "xxxxxxxxxxxxxxx",
        "user_id": "xxxxxxxxxx",
        "type": "USER"
      }
    ]
  }
}

请求参数

Path 参数

public_mailbox_id

string

必需

The unique ID or email address of a public mailbox

示例值："xxxxxxxxxxxxxxx or test_public_mailbox@xxx.xx"

Query 参数

user_id_type

string

可选

用户 ID 类型

示例值："open_id"

可选值有：

open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID
union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？
user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？
默认值：open_id

当值为 user_id，字段权限要求：

获取用户 user ID

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

items

array [object {2}]

必需

本次调用添加的公共邮箱成员列表数据校验规则：长度范围：1 ～ 200

user_id

string

可选

租户内用户的唯一标识（当成员类型是USER时有值）示例值："xxxxxxxxxx"

type

string

可选

成员类型示例值："USER" 可选值有： USER：内部用户

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

items

array [object {3}]

必需

添加成功后的公共邮箱成员信息列表

修改于 2023-02-02 09:45:37

查询所有公共邮箱成员信息

批量删除公共邮箱成员

批量添加公共邮箱成员

错误码#

请求参数

返回响应

错误码