# 更新雇佣信息 更新人事工作信息下的字段，如：工号、工作邮箱、雇佣类型、自定义字段等 **注意事项**：- 非必填字段，不传时即不做变更 - 若开启工号自动编码规则则无需输入人员“工号”，系统将自动进行工号生成；若手动输入工号，则会按照手动输入工号内容进行人员档案建立 - 暂不支持更新时间轴分组对象 ## 请求 基本 |   ---|--- HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/employments/:employment_id HTTP Method | PATCH 接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN) 支持的应用类型 | Custom App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 更新核心人事信息(corehr:corehr)
读写雇佣信息(corehr:employment:write) 字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- 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" ### 路径参数 名称 | 类型 | 描述 ---|---|--- employment_id | string | 雇佣 ID
- 类型应与 user_id_type 一致
**示例值**："1616161616" ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- client_token | string | 否 | 根据client_token是否一致来判断是否为同一请求
**示例值**：12454646 user_id_type | string | 否 | 用户 ID 类型
**示例值**：people_corehr_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- 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)
- people_corehr_id：以飞书人事的 ID 来识别用户
**默认值**：`people_corehr_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly) department_id_type | string | 否 | 此次调用中使用的部门 ID 类型
**示例值**：department_id
**可选值有**：
- open_department_id：以 open_department_id 来标识部门
- department_id：以 department_id 来标识部门
- people_corehr_department_id：以 people_corehr_department_id 来标识部门
**默认值**：`people_corehr_department_id` ### 请求体 名称 | 类型 | 必填 | 描述 ---|---|---|--- seniority_date | string | 否 | 资历起算日期
**示例值**："2020-01-01" employee_number | string | 否 | 员工编号（工号）
- 开启自动编码时不可以主动更新
- 未开启自动编码，可主动更新：
- 由数字或字母组成，请勿使用特殊字符
- 请保证唯一
**示例值**："1000000" employment_type | enum | 否 | 雇佣类型
- 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：
- object_api_name：employment
- custom_api_name：employment_type enum_name | string | 是 | 枚举值
**示例值**："employee" person_id | string | 否 | 个人信息 ID，由[【创建个人信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/person/create)时生成
**示例值**："6919733936050406926" primary_employment | boolean | 否 | 是否是主雇佣信息
**示例值**：true custom_fields | object_field_data\[\] | 否 | 自定义字段
- 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) field_name | string | 是 | 字段名
**示例值**："name" value | string | 是 | 字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", [\"id1\",\"id2\"], "2006-01-02 15:04:05")
**示例值**："\"Sandy\"" work_email_list | email\[\] | 否 | 工作邮箱列表
- 只有满足下面所有条件时，才在工作信息页面可见：
- is_primary = "true"
- is_public = "true"
- email_usage = "work" email | string | 是 | 邮箱号
**示例值**："12456@test.com" is_primary | boolean | 否 | 是否为主要邮箱
**示例值**：true is_public | boolean | 否 | 是否为公开邮箱
**示例值**：true email_usage | enum | 否 | 邮箱用途
- 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：
- object_api_name: email
- custom_api_name: email_usage
- 请勿填写 home 枚举 enum_name | string | 是 | 枚举值
**示例值**："work" custom_fields | object_field_data\[\] | 否 | 自定义字段
- 当前为预留字段，返回值为空。具体支持的对象请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) field_name | string | 是 | 字段名
**示例值**："name" value | string | 是 | 字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", [\"id1\",\"id2\"], "2006-01-02 15:04:05")
**示例值**："\"Sandy\"" reason_for_offboarding | enum | 否 | 离职原因
- 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：
- object_api_name：employment
- custom_api_name：reason_for_offboarding enum_name | string | 是 | 枚举值
**示例值**："voluntary" ats_application_id | string | 否 | 招聘投递 ID ，详细信息可以通过[【获取投递信息】](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get)接口查询获得
**示例值**："6838119494196871234" ### 请求体示例 ```json { "seniority_date": "2020-01-01", "employee_number": "1000000", "employment_type": { "enum_name": "employee" }, "person_id": "6919733936050406926", "primary_employment": true, "custom_fields": [ { "field_name": "name", "value": "\"Sandy\"" } ], "work_email_list": [ { "email": "12456@test.com", "is_primary": true, "is_public": true, "email_usage": { "enum_name": "work" }, "custom_fields": [ { "field_name": "name", "value": "\"Sandy\"" } ] } ], "reason_for_offboarding": { "enum_name": "voluntary" }, "ats_application_id": "6838119494196871234" } ``` ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \- employment | employment | 雇佣信息 prehire_id | string | 待入职ID，可通过[【查询单个待入职】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/pre_hire/get)获取详细信息 employee_type_id | string | 人员类型，可通过[【查询单个人员类型】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/employee_type/get)获取详细信息 tenure | string | 司龄 department_id | string | 部门 ID，可通过[【查询单个部门】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/department/get)获取详细信息；类型与 department_id_type 一致 job_level_id | string | 职级 ID，可通过[【查询单个职级】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_level/get)获取详细信息 work_location_id | string | 工作地点 ID，可通过[【查询单个地点】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/location/get)获取详细信息 job_family_id | string | 职务序列 ID，可通过[【查询单个序列】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get)获取详细信息 job_id | string | 职务 ID，可通过[【查询单个职务】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job/get)获取详细信息 company_id | string | 法人主体 ID，可通过[【查询单个公司】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/company/get)获取详细信息 working_hours_type_id | string | 工时制度 ID，可通过[【查询单个工时制度】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/working_hours_type/get)获取详细信息 id | string | 雇员ID；可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取更多信息；类型与 user_id_type 一致 seniority_date | string | 资历起算日期 employee_number | string | 员工编号 effective_time | string | 入职日期 expiration_time | string | 离职日期，即员工的最后一个工作日，最后一个工作日时员工的雇佣状态仍为“在职”，次日凌晨将更改为“离职” employment_type | enum | 雇佣类型
- 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：
- object_api_name：employment
- custom_api_name：employment_type enum_name | string | 枚举值 display | i18n\[\] | 枚举多语展示 lang | string | 名称信息的语言 value | string | 名称信息的内容 person_id | string | 个人信息ID，可通过[【批量查询员工信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/employee/batch_get)获取详细信息 probation_period | int | 试用期时长（月份） on_probation | string | 是否在试用期中
- 满足以下任一条件时，该字段值为`"true"`：
- 预计试用结束日期非空，且实际结束日期为空
- 预计试用结束日期非空，实际结束日期非空，且当日日期小于等于实际结束日期
- 其余情况下，该字段值为`"false"`； probation_end_date | string | 试用期结束日期（实际结束日期） primary_employment | boolean | 是否是主雇佣信息 employment_status | enum | 雇佣状态
- 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：
- object_api_name：employment
- custom_api_name：employment_status enum_name | string | 枚举值 display | i18n\[\] | 枚举多语展示 lang | string | 名称信息的语言 value | string | 名称信息的内容 custom_fields | object_field_data\[\] | 自定义字段
- 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) field_name | string | 字段名 value | string | 字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", [\"id1\",\"id2\"], "2006-01-02 15:04:05") work_email_list | email\[\] | 工作邮箱列表 email | string | 邮箱号 is_primary | boolean | 是否为主要邮箱 is_public | boolean | 是否为公开邮箱 email_usage | enum | 邮箱用途
- 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：
- object_api_name: email
- custom_api_name：email_usage enum_name | string | 枚举值 display | i18n\[\] | 枚举多语展示 lang | string | 名称信息的语言 value | string | 名称信息的内容 custom_fields | object_field_data\[\] | 自定义字段
- 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) field_name | string | 字段名 value | string | 字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", [\"id1\",\"id2\"], "2006-01-02 15:04:05") email_address | string | 邮箱 reason_for_offboarding | enum | 离职原因
- 可通过[【获取字段详情】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom_field/get_by_param)接口查询，查询参数如下：
- object_api_name：employment
- custom_api_name：reason_for_offboarding enum_name | string | 枚举值 display | i18n\[\] | 枚举多语展示 lang | string | 名称信息的语言 value | string | 名称信息的内容 cost_center_list | job_data_cost_center\[\] | 成本中心id列表 cost_center_id | string | 成本中心 ID，可以通过[【搜索成本中心信息】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/corehr-v2/cost_center/search)获取详细信息 rate | int | 分摊比例 custom_fields | object_field_data\[\] | 自定义字段
- 请参考[【自定义字段说明】](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/custom-fields-guide) field_name | string | 字段名 value | string | 字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", [\"id1\",\"id2\"], "2006-01-02 15:04:05") ats_application_id | string | 招聘投递 ID ，详细信息可以通过[【获取投递信息】](https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/application/get)接口查询获得 ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "employment": { "prehire_id": "1", "employee_type_id": "1", "tenure": "1", "department_id": "6893014062142064135", "job_level_id": "6893014062142064135", "work_location_id": "6893014062142064135", "job_family_id": "6893014062142064135", "job_id": "6893014062142064135", "company_id": "6893014062142064135", "working_hours_type_id": "6893014062142064135", "id": "6893014062142064135", "seniority_date": "2020-01-01", "employee_number": "1000000", "effective_time": "2020-01-01 00:00:00", "expiration_time": "2021-01-01 00:00:00", "employment_type": { "enum_name": "employee", "display": [ { "lang": "zh-CN", "value": "张三" } ] }, "person_id": "6919733936050406926", "probation_period": 9999, "on_probation": "true", "probation_end_date": "2022-01-01", "primary_employment": true, "employment_status": { "enum_name": "hired", "display": [ { "lang": "zh-CN", "value": "张三" } ] }, "custom_fields": [ { "field_name": "name", "value": "\"Sandy\"" } ], "work_email_list": [ { "email": "12456@test.com", "is_primary": true, "is_public": true, "email_usage": { "enum_name": "work", "display": [ { "lang": "zh-CN", "value": "张三" } ] }, "custom_fields": [ { "field_name": "name", "value": "\"Sandy\"" } ] } ], "email_address": "test@163.com", "reason_for_offboarding": { "enum_name": "voluntary", "display": [ { "lang": "zh-CN", "value": "张三" } ] }, "cost_center_list": [ { "cost_center_id": "6950635856373745165", "rate": 100, "custom_fields": [ { "field_name": "name", "value": "\"Sandy\"" } ] } ], "ats_application_id": "6838119494196871234" } } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 500 | 1160025 | didn't find employment with ID | 参数错误，请检查入参