新建分组
接口概述
- 功能:新建分组
- 请求方式:POST
- 请求地址:/api/contacts/teams/{team_id}/groups?appid={appid}&access_token={access_token}
请求参数
参数名 | 类型 | 必须 | 参数位置 | 描述 | 示例值 |
---|---|---|---|---|---|
name | string | 是 | body | 分组名称 | 测试分组 |
parent_id | integer | 否 | body | 上级分组ID | 0 |
order | integer | 否 | body | 排序 | 1 |
remote_id | string | 否 | body | 第三方系统的分组ID,用于关联 | |
team_id | integer | 是 | uri | 团队ID | 30 |
响应参数
参数名 | 类型 | 描述 |
---|---|---|
group_id | integer(uint32) | 分组ID |
name | string | 分组名称 |
响应示例
- 请求成功
{
"code": "OK",
"error": {
"type": ""
},
"data": {
"group_id": 6031,
"name": "测试子组"
},
"request_id": "7c61197c-5682-46b8-9a55-eea533ac2739"
}
- 请求失败
{
"code": "InvalidArgument",
"error": {
"type": "invalid_argument"
},
"data": {},
"request_id": "ddec96d2-165e-4f3e-8a64-2057db116983"
}
错误码
error.type 错误代码 | 错误描述 |
---|---|
invalid_argument | 参数校验不通过 |
claim_error | 无权限 |
contacts_team_not_found | |
group_too_deep | |
parent_group_not_found | |
default_group_be_modified | |
duplicated_remote_id |