修改标签

修改标签在各个语言下的名称。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v2/tags/:tag_id
HTTP Method	PATCH
接口频率限制	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"

路径参数

名称	类型	描述
tag_id	string	标签 ID 示例值："716168xxxxx"

请求体

名称	类型	必填	描述
patch_tag	patch_tag	否	编辑标签
└ id	string	否	标签 ID 示例值："716168xxxxx"
└ name	string	否	标签名称 示例值："标签名称"
└ i18n_names	tag_i18n_name\[\]	否	i18n 多语言名称集合 数据校验规则： - 长度范围：0 ～ 40
└ locale	string	是	语言 示例值："zh_cn"
└ name	string	否	名称 示例值："标签2"

请求体示例

{
    "patch_tag": {
        "id": "716168xxxxx",
        "name": "标签名称",
        "i18n_names": [
            {
                "locale": "zh_cn",
                "name": "标签2"
            }
        ]
    }
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ tag_info	tag_info	编辑后的标签信息
└ id	string	标签 ID
└ tag_type	string	标签类型
└ name	string	标签名称
└ i18n_names	tag_i18n_name\[\]	i18n 多语言名称集合
└ locale	string	语言
└ name	string	名称
└ create_time	string	创建时间
└ update_time	string	更新时间
└ patch_tag_fail_reason	patch_tag_fail_reason	修改失败原因
└ duplicate_id	string	名称重复的标签id

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "tag_info": {
            "id": "716168xxxxx",
            "tag_type": "tenant",
            "name": "标签1",
            "i18n_names": [
                {
                    "locale": "zh_cn",
                    "name": "标签2"
                }
            ],
            "create_time": "1700793403850",
            "update_time": "1700793403850"
        },
        "patch_tag_fail_reason": {
            "duplicate_id": "716168xxxxx"
        }
    }
}

错误码

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