更新三方协议
更新三方协议的状态及修改时间信息。
前提条件
在「飞书招聘」-「设置」-「候选人流程管理」-「三方协议设置」中勾选了「通过 API 维护三方协议」。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/hire/v1/tripartite_agreements/:tripartite_agreement_id |
| HTTP Method | PUT |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | hire:tripartite_agreement 更新三方协议 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
tripartite_agreement_id | string | 三方协议 ID,可通过获取三方协议获取 示例值:"7084008015948283905" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
state | int | 是 | 三方协议状态 示例值:1 可选值有: - 1: 未开始 - 2: 已申请 - 3: 学生处理中 - 4: 公司处理中 - 5: 学校处理中 - 6: 已终止 - 7: 已完成 - 8: 解约处理中 - 9: 已解约 |
modify_time | string | 是 | 三方协议修改时间,毫秒时间戳 注意:不可小于创建时间或者上次修改时间 示例值:"1698292282661" |
请求体示例
json
{
"state": 1,
"modify_time": "1698292282661"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "SUCCESS",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询技术支持 |
| 400 | 1002002 | 参数错误 | 检查参数是否正确,例如类型,大小 |
| 400 | 1002075 | 三方协议不存在 | tripartite_agreement_id 不合法,请检查入参 tripartite_agreement_id 是否正确 |
| 400 | 1002076 | 通过 API 维护三方协议开关未开启 | 请联系管理员前往招聘系统后台在「飞书招聘」-「设置」-「候选人流程管理」-「三方协议设置」中勾选「通过 API 维护三方协议」 |
更多错误码信息,参见通用错误码。
