创建标签

创建标签并返回标签 ID。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v2/tags
HTTP Method	POST
接口频率限制	5 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	im:tag:write 编辑标签信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

名称	类型	必填	描述
create_tag	create_tag	是	创建标签
└ tag_type	string	是	标签类型 示例值："tenant" 可选值有： - tenant: 租户类型标签
└ name	string	是	标签默认名称 示例值："default name"
└ i18n_names	tag_i18n_name\[\]	否	i18n多语言标签名称集合 数据校验规则： - 长度范围：0 ～ 40
└ locale	string	是	语言 示例值："zh_cn"
└ name	string	否	名称 示例值："标签1"

请求体示例

{
    "create_tag": {
        "tag_type": "tenant",
        "name": "default name",
        "i18n_names": [
            {
                "locale": "zh_cn",
                "name": "标签1"
            }
        ]
    }
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ id	string	创建的 tag 的 ID
└ create_tag_fail_reason	create_tag_fail_reason	创建失败原因
└ duplicate_id	string	名称重复的标签id

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "id": "716168xxxxx",
        "create_tag_fail_reason": {
            "duplicate_id": "716168xxxxx"
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	230001	param is invalid	参数错误，请根据接口返回的错误信息或文档内容重新输入