# 创建邮件组成员

向邮件组添加单个成员。

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/mail/v1/mailgroups/:mailgroup_id/members
HTTP Method | POST
接口频率限制 | [50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查询、创建、修改、删除邮件组(mail:mailgroup)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请<br>获取用户 user ID(contact:user.employee_id:readonly)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 路径参数

名称 | 类型 | 描述
---|---|---
mailgroup_id | string | 邮件组ID或者邮件组地址<br>**示例值**："xxxxxxxxxxxxxxx 或 test_mail_group@xxx.xx"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_type | string | 否 | 用户 ID 类型<br>**示例值**：open_id<br>**可选值有**：<br>- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)<br>- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)<br>- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)<br>**默认值**：`open_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)
department_id_type | string | 否 | 此次调用中使用的部门ID的类型<br>**示例值**：open_department_id<br>**可选值有**：<br>- department_id：以自定义department_id来标识部门<br>- open_department_id：以open_department_id来标识部门

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
email | string | 否 | 成员邮箱地址（当成员类型是EXTERNAL_USER/MAIL_GROUP/OTHER_MEMBER时有值）<br>**示例值**："test_member@xxx.xx"
user_id | string | 否 | 租户内用户的唯一标识（当成员类型是USER时有值）<br>**示例值**："xxxxxxxxxx"
department_id | string | 否 | 租户内部门的唯一标识（当成员类型是DEPARTMENT时有值）<br>**示例值**："xxxxxxxxxx"
type | string | 否 | 成员类型<br>**示例值**："USER"<br>**可选值有**：<br>- USER：内部用户<br>- DEPARTMENT：部门<br>- COMPANY：全员<br>- EXTERNAL_USER：外部用户<br>- MAIL_GROUP：邮件组<br>- PUBLIC_MAILBOX：member is a public mailbox<br>- OTHER_MEMBER：内部成员

### 请求体示例
```json
{
    "email": "test_member@xxx.xx",
    "user_id": "xxxxxxxxxx",
    "department_id": "xxxxxxxxxx",
    "type": "USER"
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | mailgroup.member | \-
member_id | string | 邮件组内成员唯一标识（在请求体中不用填）
email | string | 成员邮箱地址（当成员类型是EXTERNAL_USER/MAIL_GROUP/OTHER_MEMBER时有值）
user_id | string | 租户内用户的唯一标识（当成员类型是USER时有值）
department_id | string | 租户内部门的唯一标识（当成员类型是DEPARTMENT时有值）
type | string | 成员类型<br>**可选值有**：<br>- USER：内部用户<br>- DEPARTMENT：部门<br>- COMPANY：全员<br>- EXTERNAL_USER：外部用户<br>- MAIL_GROUP：邮件组<br>- PUBLIC_MAILBOX：member is a public mailbox<br>- OTHER_MEMBER：内部成员

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "member_id": "xxxxxxxxxxxxxxx",
        "email": "test_member@xxx.xx",
        "user_id": "xxxxxxxxxx",
        "department_id": "xxxxxxxxxx",
        "type": "USER"
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
404 | 1234013 | mail group not found | 请确认邮件组是否存在
400 | 1234008 | request parameter error | 请检查请求参数是否正确
400 | 1234030 | mailing group member count is over max limit | 邮件组成员已达上限，请删除后重新尝试

