# 修改勋章信息
通过该接口可以修改勋章的信息。
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/admin/v1/badges/:badge_id
HTTP Method | PUT
接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查看、创建、编辑勋章信息和上传勋章图片(admin:badge)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 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"
### 路径参数
名称 | 类型 | 描述
---|---|---
badge_id | string | 勋章ID
**示例值**："m_MzfKDM"
**数据校验规则**：
- 长度范围：`1` ～ `64` 字符
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
name | string | 是 | 租户内唯一的勋章名称，最多30个字符。
**示例值**："激励勋章"
explanation | string | 否 | 勋章的描述文案，最多100个字符。
**示例值**："这枚勋章为了激励员工颁发。"
detail_image | string | 是 | 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。
**示例值**："75a1949f-d9df-4b46-bc88-dacc51e88f3j"
**数据校验规则**：
- 最小长度：`1` 字符
show_image | string | 是 | 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。
**示例值**："03daa74a-159f-49e9-963e-b6c4d76103fj"
**数据校验规则**：
- 最小长度：`1` 字符
i18n_name | i18n | 否 | 勋章的多语言名称，同name字段限制，最多30个字符。
**示例值**：{ "zh_cn": "激励勋章", "en_us": "Incentive Medal", "ja_jp": "奨励メダル" }
zh_cn | string | 否 | 中文文案
**示例值**："激励勋章"
**数据校验规则**：
- 最小长度：`1` 字符
en_us | string | 否 | 英文文案
**示例值**："Incentive Medal"
**数据校验规则**：
- 最小长度：`1` 字符
ja_jp | string | 否 | 日文文案
**示例值**："奨励メダル"
**数据校验规则**：
- 最小长度：`1` 字符
i18n_explanation | i18n | 否 | 勋章的多语言描述文案，同explanation字段限制，最多100个字符。
**示例值**：{ "zh_cn": "这枚勋章为了激励员工颁发。", "en_us": "This medal is awarded to motivate employees.", "ja_jp": "このメダルは、従業員のモチベーションを高めるために授与されます。" }
zh_cn | string | 否 | 中文文案
**示例值**："激励勋章"
**数据校验规则**：
- 最小长度：`1` 字符
en_us | string | 否 | 英文文案
**示例值**："Incentive Medal"
**数据校验规则**：
- 最小长度：`1` 字符
ja_jp | string | 否 | 日文文案
**示例值**："奨励メダル"
**数据校验规则**：
- 最小长度：`1` 字符
### 请求体示例
```json
{
"name": "激励勋章",
"explanation": "这枚勋章为了激励员工颁发。",
"detail_image": "75a1949f-d9df-4b46-bc88-dacc51e88f3j",
"show_image": "03daa74a-159f-49e9-963e-b6c4d76103fj",
"i18n_name": {
"zh_cn": "激励勋章",
"en_us": "Incentive Medal",
"ja_jp": "奨励メダル"
},
"i18n_explanation": {
"zh_cn": "激励勋章",
"en_us": "Incentive Medal",
"ja_jp": "奨励メダル"
}
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
badge | badge | 勋章信息
id | string | 租户内勋章的唯一标识，该值由系统随机生成。
name | string | 租户内唯一的勋章名称，最多30个字符。
explanation | string | 勋章的描述文案，最多100个字符。
detail_image | string | 企业勋章的详情图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。
show_image | string | 企业勋章的头像挂饰图Key。1.权限校验：非本租户上传的图片key，不能直接使用；2.时效校验：创建勋章，或者修改勋章图片key时，需使用1h内上传的图片key。
i18n_name | i18n | 勋章的多语言名称，同name字段限制，最多30个字符。
zh_cn | string | 中文文案
en_us | string | 英文文案
ja_jp | string | 日文文案
i18n_explanation | i18n | 勋章的多语言描述文案，同explanation字段限制，最多100个字符。
zh_cn | string | 中文文案
en_us | string | 英文文案
ja_jp | string | 日文文案
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"badge": {
"id": "m_MzfKDM",
"name": "激励勋章",
"explanation": "这枚勋章为了激励员工颁发。",
"detail_image": "75a1949f-d9df-4b46-bc88-dacc51e88f3j",
"show_image": "03daa74a-159f-49e9-963e-b6c4d76103fj",
"i18n_name": {
"zh_cn": "激励勋章",
"en_us": "Incentive Medal",
"ja_jp": "奨励メダル"
},
"i18n_explanation": {
"zh_cn": "激励勋章",
"en_us": "Incentive Medal",
"ja_jp": "奨励メダル"
}
}
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1051000 | unknown server error | 服务内部错误，请稍后重试
400 | 1051001 | request contain invalid param | 请求中包含非法参数
403 | 1051002 | request to exceed authority | 请求发生越权
400 | 1051103 | badge name are duplicated | 勋章名称发生冲突
400 | 1051104 | cannot exceed the max length limit of badge name | 勋章名称超过最大长度
400 | 1051105 | cannot exceed the max length limit of badge explanation | 勋章解读文案超过最大长度
400 | 1051106 | badge image in request payload is not belong to current tenant | 请求中包含其它租户的图片
400 | 1051113 | cannot find this badge | 未找到该勋章的信息