# 更新备注

根据备注 ID 更新备注信息。

## 注意事项

在备注中@其他用户时，会同时赋予该用户查看该人才的权限，即该用户有权限在「飞书招聘」产品中查看该人才。

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/hire/v1/notes/:note_id
HTTP Method | PATCH
接口频率限制 | [20 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 更新招聘备注信息(hire:note)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请<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"

### 路径参数

名称 | 类型 | 描述
---|---|---
note_id | string | 备注 ID，可通过[获取备注列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/note/list)获取<br>**示例值**："6960663240925956401"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
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>- people_admin_id：以people_admin_id来识别用户<br>**默认值**：`open_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
content | string | 是 | 备注内容<br>**示例值**："这是一个备注"
operator_id | string | 否 | 更新人 ID，请传入与`user_id_type`相匹配的ID<br>**示例值**："ou_f476cb099ac9227c9bae09ce46112579"
notify_mentioned_user | boolean | 否 | 是否通知被@的用户<br>**示例值**：false<br>**默认值**：`false`
mention_entity_list | mention_entity\[\] | 否 | 被@用户列表
offset | int | 是 | 被@用户在 content 中的偏移量<br>- 取值范围：0 ~ content.length<br>**示例值**：3
user_id | string | 是 | 被@用户的 ID，请传入与 `user_id_type` 类型相匹配的 ID<br>**示例值**："on_94a1ee5551019f18cd73d9f111898cf2"

### 请求体示例
```json
{
    "content": "这是一个备注",
    "operator_id": "ou_f476cb099ac9227c9bae09ce46112579",
    "notify_mentioned_user": false,
    "mention_entity_list": [
        {
            "offset": 3,
            "user_id": "on_94a1ee5551019f18cd73d9f111898cf2"
        }
    ]
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
note | note | 备注数据
id | string | 备注ID
talent_id | string | 人才ID
application_id | string | 投递ID
is_private | boolean | 是否私密
create_time | int | 创建时间，毫秒时间戳
modify_time | int | 更新时间，毫秒时间戳
creator_id | string | 创建人ID，与入参 `user_id_type` 类型一致
content | string | 备注内容

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "note": {
            "id": "6949805467799537964",
            "talent_id": "6916472453069883661",
            "application_id": "6891565253964859661",
            "is_private": false,
            "create_time": 1618209327096,
            "modify_time": 1618209327096,
            "creator_id": "ou_f476cb099ac9227c9bae09ce46112579",
            "content": "这是一个备注"
        }
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询[技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1002002 | 参数错误 | 检查参数是否正确，例如类型，大小