# 更新员工状态

根据员工 ID 更新员工招聘系统内的转正、离职状态。

## 请求

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

### 路径参数

名称 | 类型 | 描述
---|---|---
employee_id | string | 员工ID，请参考：[通过投递 ID 获取入职信息](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/get_by_application)<br>**示例值**："6891613503971461384"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
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>**默认值**：`open_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)
department_id_type | string | 否 | 指定查询结果中的部门 ID 类型。关于部门 ID 的详细介绍，可参见[部门资源介绍](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview)。<br>**示例值**：department_id<br>**可选值有**：<br>- open_department_id：以 open_department_id 来标识部门<br>由系统自动生成的部门 ID，ID 前缀固定为 `od-`，在租户内全局唯一。<br>- department_id：支持用户自定义配置的部门 ID。自定义配置时可复用已删除的 department_id，因此在未删除的部门范围内 department_id 具有唯一性。<br>- people_admin_department_id：以 people_admin_department_id 来标识部门<br>**默认值**：`people_admin_department_id`
job_level_id_type | string | 否 | 此次调用中使用的「职级 ID」的类型<br>**示例值**：6942778198054125570<br>**可选值有**：<br>- people_admin_job_level_id：「人力系统管理后台」适用的职级 ID。人力系统管理后台逐步下线中，建议不继续使用此 ID。<br>- job_level_id：「飞书管理后台」适用的职级 ID，通过 [获取租户职级列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_level/list)<br>接口获取<br>**默认值**：`people_admin_job_level_id`
job_family_id_type | string | 否 | 此次调用中使用的「序列 ID」的类型<br>**示例值**：6942778198054125571<br>**可选值有**：<br>- people_admin_job_category_id：「人力系统管理后台」适用的序列 ID。人力系统管理后台逐步下线中，建议不继续使用此 ID。<br>- job_family_id：「飞书管理后台」适用的序列 ID，通过 [获取租户序列列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/job_family/list)<br>接口获取<br>**默认值**：`people_admin_job_category_id`
employee_type_id_type | string | 否 | 此次调用中使用的「人员类型 ID」的类型<br>**示例值**：1<br>**可选值有**：<br>- people_admin_employee_type_id：「人力系统管理后台」适用的人员类型 ID。人力系统管理后台逐步下线中，建议不继续使用此 ID。<br>- employee_type_enum_id：「飞书管理后台」适用的人员类型 ID，通过 [查询人员类型](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list)接口获取<br>**默认值**：`people_admin_employee_type_id`

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
operation | int | 是 | 修改状态操作类型<br>**示例值**：1<br>**可选值有**：<br>- 1：转正<br>- 2：离职<br>- 3：恢复至待入职<br>- 4：撤销离职（恢复至已入职）<br>- 5：撤销转正（恢复至待转正）
conversion_info | employee_conversion_info | 否 | 转正信息，操作类型operation为`转正`时必填
actual_conversion_time | int | 否 | 实际转正日期，毫秒时间戳<br>**示例值**：1637596800000
overboard_info | employee_overboard_info | 否 | 离职信息，操作类型operation为`离职`时必填
actual_overboard_time | int | 否 | 实际离职日期，毫秒时间戳<br>**示例值**：1637596800000
overboard_note | string | 否 | 离职原因<br>**示例值**："职业发展考虑"

### 请求体示例
```json
{
    "operation": 1,
    "conversion_info": {
        "actual_conversion_time": 1637596800000
    },
    "overboard_info": {
        "actual_overboard_time": 1637596800000,
        "overboard_note": "职业发展考虑"
    }
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
employee | employee | 员工信息
id | string | 员工ID
application_id | string | 投递ID，详情请查看：[获取投递信息](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get)
onboard_status | int | 入职状态<br>**可选值有**：<br>- 1：已入职<br>- 2：已离职
conversion_status | int | 转正状态<br>**可选值有**：<br>- 1：未转正<br>- 2：已转正
onboard_time | int | 实际入职时间，毫秒时间戳
expected_conversion_time | int | 预期转正时间，毫秒时间戳
actual_conversion_time | int | 实际转正时间，毫秒时间戳
overboard_time | int | 离职时间，毫秒时间戳
overboard_note | string | 离职原因
onboard_city_code | string | 办公地点，详情请查看：[查询地点列表](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/location/query)
department | string | 入职部门ID，与入参中的`department_id_type`类型一致，详情请查看：[获取单个部门信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/get)
leader | string | 直属上级用户ID，与入参`user_id_type`类型一致
sequence | string | 序列ID，与入参`job_family_id_type` 类型一致
level | string | 职级ID，与入参`job_level_id_type` 类型一致
employee_type | string | 员工类型ID，与入参`employee_type_id_type` 类型一致
job_requirement_id | string | 招聘需求ID

### 响应体示例
```json
{
    "code": 0,
    "msg": "ok",
    "data": {
        "employee": {
            "id": "7095600054216542508",
            "application_id": "7073372582620416300",
            "onboard_status": 1,
            "conversion_status": 1,
            "onboard_time": 1637596800000,
            "expected_conversion_time": 1637596800000,
            "actual_conversion_time": 1637596800000,
            "overboard_time": 1637596800000,
            "overboard_note": "职业发展考虑",
            "onboard_city_code": "CT_2",
            "department": "6966123381141866028",
            "leader": "ou-xxx",
            "sequence": "6937934036379650311",
            "level": "7006234385490345986",
            "employee_type": "1",
            "job_requirement_id": "123123123213"
        }
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
500 | 1002001 | 系统错误 | 请根据实际报错信息定位或咨询[技术支持](https://applink.feishu.cn/TLJpeNdW)
400 | 1002002 | 参数错误 | 检查参数是否正确，例如类型，大小
400 | 1002908 | EHR同步开关未开启 | 请在招聘后台允许ehr同步；路径：招聘系统->设置->生态对接->e-HR/OA办公系统->通过e-HR/OA办公系统同步候选人入职、转正、离职事件
400 | 1002905 | 非法时间 | 请确认入参`actual_conversion_time `或`actual_overboard_time `是否正确
400 | 1002903 | 员工不存在 | 请确认入参`employee_id `是否正确
400 | 1002902 | 当前员工状态不支持此操作 | 请检查当前员工的状态
400 | 1002907 | 员工不允许撤销离职 | 请确认当前员工处于离职状态
400 | 1002910 | 候选人已经同步到飞书人事，请通过飞书人事进行相关操作 | 请到飞书人事（企业版）进行相关操作

