创建邮件组成员

POST

/open-apis/mail/v1/mailgroups/{mailgroup_id}/members

向邮件组添加单个成员

错误码

HTTP状态码	错误码	描述	排查建议
404	1234013	mail group not found	请确认邮件组是否存在
400	1234008	request parameter error	请检查请求参数是否正确

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/mail/v1/mailgroups/"xxxxxxxxxxxxxxx 或 test_mail_group@xxx.xx"/members?user_id_type=open_id&department_id_type=open_department_id' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "test_memeber@xxx.xx",
    "user_id": "xxxxxxxxxx",
    "department_id": "xxxxxxxxxx",
    "type": "USER"
}'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "member_id": "xxxxxxxxxxxxxxx",
        "email": "test_memeber@xxx.xx",
        "user_id": "xxxxxxxxxx",
        "department_id": "xxxxxxxxxx",
        "type": "USER"
    }
}

请求参数

Path 参数

mailgroup_id

必需

邮件组ID或者邮件组地址示例值："xxxxxxxxxxxxxxx 或 test_mail_group@xxx.xx"

示例值:

"xxxxxxxxxxxxxxx 或 test_mail_group@xxx.xx"

Query 参数

user_id_type

必需

用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

示例值:

open_id

department_id_type

必需

此次调用中使用的部门ID的类型示例值："open_department_id" 可选值有： department_id：以自定义department_id来标识部门 open_department_id：以open_department_id来标识部门

示例值:

open_department_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

string

必需

成员邮箱地址（当成员类型是EXTERNAL_USER/MAIL_GROUP/OTHER_MEMBER时有值）示例值："test_memeber@xxx.xx"

user_id

string

必需

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

department_id

string

必需

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

type

string

必需

成员类型示例值："USER" 可选值有： USER：内部用户 DEPARTMENT：部门 COMPANY：全员 EXTERNAL_USER：外部用户 MAIL_GROUP：邮件组 OTHER_MEMBER：内部成员

示例

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

member_id

string

必需

邮件组内成员唯一标识

string

必需

成员邮箱地址（当成员类型是EXTERNAL_USER/MAIL_GROUP/OTHER_MEMBER时有值）

user_id

string

必需

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

department_id

string

必需

租户内部门的唯一标识（当成员类型是DEPARTMENT时有值）

type

string

必需

成员类型可选值有： USER：内部用户 DEPARTMENT：部门 COMPANY：全员 EXTERNAL_USER：外部用户 MAIL_GROUP：邮件组 OTHER_MEMBER：内部成员

修改于 2023-02-02 08:45:18

批量获取邮件组

删除邮件组成员

创建邮件组成员

错误码#

请求参数

返回响应

错误码