--- title: "Update employee" method: PATCH path: "/hris/employees/{employee_id}" tags: ["Unified HRIS API"] --- # Update employee `PATCH /hris/employees/{employee_id}` Update an employee. This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes). ### Example Request Body ```json { "employee_id": "BkgfzSr5muN9cUTMD4wDQFn4", "first_name": "John", "last_name": "Doe", "work_email": "john.doe@acme.com", "ssn": "555-32-6395", "tax_id": "12 345 678 901", "gender": "MALE", "marital_status": "MARRIED", "date_of_birth": "1986-01-01", "start_date": "2020-04-07", "termination_date": "2022-05-20", "job_title": "Integrations Team Lead", "nationality": "DE", "home_address": { "city": "Berlin", "country": "DE", "state": "Berlin", "street_1": "Sonnenallee 63", "zip_code": "12045" } } ``` ## Path parameters - `employee_id` string, required — The ID of the employee that should be updated. You can use their Kombo `id` or their ID in the remote system by prefixing it with `remote:` (e.g., `remote:12312`) ## Headers - `X-Integration-Id` string, required ## Request body - PatchHrisEmployeesEmployeeIdRequestBody - `first_name` string — The first name of the employee. - `last_name` string — The last name of the employee. - `work_email` string, email, required — The email address of the employee to be updated. For tools where the personal email address is required, we map this input to the personal email. This is documented on a per-tool basis. - `gender` 'MALE' | 'FEMALE' | 'NON_BINARY' | 'NOT_SPECIFIED' — The gender of the employee. - `job_title` string — The title of the position this person is working in. - `home_address` object — The employee's home address. - `street_1` string - `street_2` string - `city` string - `state` string - `zip_code` string - `country` string — The uppercase two-letter ISO country (e.g., `DE`). For systems that use codes in formats other than `ISO 3166-1 alpha-2`, Kombo transforms the ISO Codes to the appropriate value. - `date_of_birth` string, date-time — The employee's date of birth. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. - `mobile_phone_number` string - `home_phone_number` string - `nationality` string — The uppercase two-letter ISO country (e.g., `DE`). For systems that use codes in formats other than `ISO 3166-1 alpha-2`, Kombo transforms the ISO Codes to the appropriate value. - `start_date` string, date-time — Start date of the employee. Also considered to be the hire date. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. - `legal_entity_id` string — The Kombo ID of the legal entity the employee should be in. This field is required for certain integrations. - `location_id` string — The Kombo ID of the location the employee should be in. This field is required for certain integrations. - `remote_fields` object — Additional fields that we will pass through to specific HRIS systems. - `humaans` object — Fields specific to Humaans. - `employee` object — Fields that we will pass through to Humaans `Employee` object. - `hibob` object — Fields specific to HiBob. - `employee` object — Fields that we will pass through to HiBob's `Person` endpoint. - `sympa` object — Fields specific to Sympa. - `GenericNewHire` object — Fields that we will pass through to Sympa's `Employee` object. - `silae` object — Fields specific to Silae. - `siret` string — The siret of the company. The siret can be found as the remote ID of a Silae legal entity. - `employee` object — Fields that we will passed through to Silae `Employee` object. - `employment` object — Fields that we will passed through to Silae `Employment` object. - `sagehr` object — Fields specific to Sage HR. - `employee` object — Fields that we will pass through to Sage HR's create employee endpoint. Use this for Sage HR fields without a unified equivalent, e.g. `marital_status`, `work_phone`, `tax_number`, `personal_identification_number`, `irregular_contract_worker`, `send_email`, or `nationality` (Sage HR expects a demonym such as `Canadian`). These take precedence over the fields we map ourselves. - `team_id` string — The remote ID of a Kombo group with type `TEAM` that the employee should be assigned to. - `leader_id` string — The remote ID of the Kombo employee that should become this employee's manager. - `position_id` string — The ID of the Sage HR position the employee should be assigned to. Kombo does not sync Sage HR positions, so this has to be a raw Sage HR ID, which you can list through Sage HR's `GET /positions` endpoint. - `location_id` string — The ID of the Sage HR location the employee should be assigned to. Sage HR does not expose locations via its API, so this has to be a raw Sage HR ID. - `employee_number` string — The employee number to assign to the employee. - `approver_ids` string[] — The remote IDs of the Kombo employees that should approve this employee's absences. - `selected_leave_types` string[] — The remote IDs of the Kombo absence types the employee should be enrolled in. - `custom_fields` object — Values for Sage HR custom fields, keyed by the Sage HR custom field ID. That ID is the `key` of the corresponding `CUSTOM` entry in the employee's `integration_fields`. Sage HR tag fields, which hold multiple values, are not supported. - `peoplehr` object — Fields specific to PeopleHR. - `job_role_effective_date` string, date-time — The effective date of the employee's current role. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. - `department` string - `zohopeople` object — Fields specific to Zoho People. - `employee_id` string — A personnel code used to identify individuals working for the business. - `workday` object — Fields specific to Workday. - `job_requisition_id` string — Workday job requisition ID of that the employee should be hired for. Provide either this or `position_id`. - `position_id` string — Workday position ID of that the employee should be hired to. Provide either this or `job_requisition_id`. - `ssn` string — The social security number of the employee. - `bank_account` object — The employee's bank account. - `iban` string, required - `bic` string, required - `bank_name` string, required - `deel` object — Fields specific to Deel. - `candidate_id` string, required — The unique identifier of the candidate in the ATS. - `candidate_link` string, required — The link to the candidate's profile in the ATS. - `bamboohr` object — Fields specific to BambooHR. - `employee` object — Fields that we will pass through to BambooHR `Employee` object. - `oracle` object — Fields specific to Oracle HCM. - `group_id` string, required — The business unit group ID for which the employee should be created. It can be found as a group with the type `null`. - `department_id` string, required — The department group ID for which the employee should be created. It can be found as a group with the type `DEPARTMENT`. - `adpworkforcenow` object — Fields specific to ADP Workforce Now. - `onboarding_template_code` string, required — The onboarding template to be used for the created employee. View the possible values in the Kombo dashboard by clicking on the ADP Workforce Now integration and viewing the field report in the settings tab. - `applicant_payroll_profile_group_code` string, required — The payroll group code (a.k.a. "Company Code") to be used for the created employee. View the possible values in the Kombo dashboard by clicking on the ADP Workforce Now integration and viewing the field report in the settings tab. - `manager_position_id` string — The position ID of the employment of the manager. Available as mappable custom field on employments. Not the employment ID or employment remote ID! - `home_organization_unit_code` string — The remote id of a Kombo group with type "DEPARTMENT" that will be used as the employee's home department. - `personal_email` string — The personal email for the employee. - `azuread` object — Fields specific to Azure AD/Entra ID. - `password` string, required — Azure / entra requires a password to be set when creating a user. The user has to use the password on his initial sign-in and will be forced to change the password once signed in. - `paycor` object — Fields specific to Paycor. - `paygroupRemoteId` string, required — [REQUIRED] Remote ID of a Kombo Group with type "COST_CENTER" - `departmentRemoteId` string, required — [REQUIRED] Remote ID of a Kombo Group with type "DEPARTMENT" - `planday` object — Fields specific to PlanDay. - `department_remote_id` string, required — The remote ID of the department for which the employee should be assigned to. It can be found as a group with the type `DEPARTMENT`. - `dayforce` object — Fields specific to Dayforce. - `social_security_number` string, required — The social security number of the employee - `pay_type` string, required — The pay type of the employee. This needs to be a valid XRefCode from Dayforce. - `pay_class` string, required — The pay class of the employee. This needs to be a valid XRefCode from Dayforce. - `pay_group` string, required — The pay group of the employee. This needs to be a valid XRefCode from Dayforce. - `base_rate` number, double, required — The base rate of the employee. - `role` string, required — The role of the employee. This needs to be a valid XRefCode from Dayforce. - `location` string, required — The location of the employee. This needs to be a valid XRefCode from Dayforce. - `department` string, required — The department of the employee. This needs to be a valid XRefCode from Dayforce. - `job` string, required — The job of the employee. This needs to be a valid XRefCode from Dayforce. - `country` string, required — The country of the employee. This needs to be a valid XRefCode from Dayforce. - `ssn` string — The social security number of the employee. - `marital_status` 'SINGLE' | 'MARRIED' | 'DOMESTIC_PARTNERSHIP' | 'WIDOWED' | 'DIVORCED' | 'SEPARATED' | 'NOT_MARRIED' — The marital status of an employee. - `termination_date` string, date-time — The date on which the employment ends. This date can be in the past or in the future. This is a plain date (i.e., `yyyy-MM-dd`), all time information is discarded. - `tax_id` string — Tax ID of the employee. Most countries have different formats of that. In Germany, this is the `Steuer ID` and in the US it's the `TIN`. ## Response `200` PATCH /hris/employees/:employee_id Positive response - PatchHrisEmployeesEmployeeIdPositiveResponse - `status` 'success', required - `data` object, required - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing. - `remote_id` string, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key. - `employee_number` string, nullable, required — The employee’s organization-internal employee number. - `first_name` string, nullable, required — The employee’s first name. - `last_name` string, nullable, required — The employee’s last name. - `nationality` string, nullable, required — The employee’s nationality. - `display_full_name` string, nullable, required — The employee’s full name, including any middle names. Not all HR systems provide an explicit display name, so we recommend falling back to `first_name` and `last_name`. - `job_title` string, nullable, required — The employee’s job title. - `work_email` string, nullable — The employee’s work email address. If the email address is invalid, we will set this to `null`. - `personal_email` string, nullable — The employee’s personal email address. If the email address is invalid, we will set this to `null`. - `mobile_phone_number` string, nullable, required — The employee’s mobile phone number. - `ssn` string, nullable, required — The employee’s social security number - `tax_id` string, nullable, required — The employee’s tax ID. - `gender` union — The employee’s gender. - 'MALE' | 'FEMALE' | 'NON_BINARY' | 'NOT_SPECIFIED' - string — If we can't find a clear mapping: The original string passed through. - `ethnicity` union — The employee’s ethnicity. In rare cases where we can’t find a clear mapping, the original string is passed through. - 'WHITE' | 'ASIAN' | 'HISPANIC_LATINO' | 'HAWAIIAN' | 'NATIVE_AMERICAN' | 'BLACK_AFRICAN_AMERICAN' | 'MULTIPLE_ETHNICITIES' | 'DECLINE_TO_SPECIFY' - string — If we can't find a clear mapping: The original string passed through. - `marital_status` union — The employee’s current marital status. In rare cases where we can’t find a clear mapping, the original string is passed through. - 'SINGLE' | 'MARRIED' | 'DOMESTIC_PARTNERSHIP' | 'WIDOWED' | 'DIVORCED' | 'SEPARATED' | 'NOT_MARRIED' - string — If we can't find a clear mapping: The original string passed through. - `employment_status` union — The employee’s current employment status: - `ACTIVE`: the employee is **actively employed** - `PENDING`: the employee is **not actively employed yet** (but they signed their contract or are part of an onboarding process) - `INACTIVE`: the employee is **not actively employed** anymore - `LEAVE`: the employee is still employed but **currently on leave** (note that not all HR systems support this status — use our absences API for detailed information) In rare cases where we can’t find a clear mapping, the original string is passed through. - 'ACTIVE' | 'PENDING' | 'INACTIVE' | 'LEAVE' - string — If we can't find a clear mapping: The original string passed through. - `employment_type` union — The employee’s current employment type: - `FULL_TIME`: the employee is actively employed - `PART_TIME`: the employee is working only part of the usual working hours - `CONTRACT`: the employee is working temporarily under a contract - `INTERNSHIP`: the employee is working as an intern - `FREELANCE`: the employee is working as a freelancer - `WORKING_STUDENT`: the employee is working as a working student - `APPRENTICESHIP`: the employee is working in an apprenticeship - `TRAINING`: the employee is working in a training program In rare cases where we can’t find a clear mapping, the original string is passed through. - 'FULL_TIME' | 'PART_TIME' | 'CONTRACT' | 'INTERNSHIP' | 'FREELANCE' | 'WORKING_STUDENT' | 'APPRENTICESHIP' | 'TRAINING' - string — If we can't find a clear mapping: The original string passed through. - `weekly_hours` number, double, nullable, required — The employee’s weekly working hours. - `avatar` string, nullable, required — URL to the employee’s avatar. This is either the raw URL from the HR system (in cases where it can be requested without short-lived authentication) _or_ a URL to a temporarily cached version of the file hosted by Kombo. Kombo will delete the cached file after its deletion in the source system. - `work_location_id` string, nullable, required — The Kombo ID of the employee’s work location. The ID can be used to retrieve the work location from the `get work locations` endpoint. - `legal_entity_id` string, nullable, required — The Kombo ID of the employee’s legal entity. The ID can be used to retrieve the legal entity from the `get legal entities` endpoint. - `manager_id` string, nullable, required — The Kombo ID of the employee’s manager. The ID can be used to retrieve the manager from the `get employees` endpoint. - `home_address` object, nullable — The employee’s home address. - `city` string, nullable - `country` string, nullable — Contains the ISO2 country code if possible. If not, it contains the original value. - `raw` string, nullable — If we have address data, this is filled with the raw address string. - `state` string, nullable - `street_1` string, nullable — If we can parse the address data, this field contains the first part of the street information. - `street_2` string, nullable - `zip_code` string, nullable - `bank_accounts` object[], nullable — The employee’s bank accounts. - `iban` string, nullable — The internationally unique IBAN identifying this account. If we detect a valid IBAN from the account number and this field would otherwise be empty, we will automatically populate this field. - `bic` string, nullable — The internationally unique BIC/SWIFT code identifying the bank behind this account. If we detect a valid BIC from the domestic bank routing number and this field would otherwise be empty, we will automatically populate this field. - `account_number` string, nullable — The bank-specific account number. Some companies use the account number field to put the IBAN here. - `holder_name` string, nullable — The name of the holder of this account. - `bank_name` string, nullable — The name of the bank behind this account. - `domestic_bank_routing` object, nullable - `number` string, required — Bank routing number (e.g. DE Bankleitzahl, GB Sort Code, US ABA routing number, AU BSB code). This field is not formatted and therefore might contain delimiters (eg. 01-23-45). - `type` 'GB_SORT_CODE' | 'DE_BANKLEITZAHL' | 'US_ABA_ROUTING_TRANSIT_NUMBER' | 'CA_ROUTING_NUMBER' | 'AU_BSB_CODE' | 'FR_RIB', nullable, required — Enum of the routing type, prefixed with the iso-3166-1-alpha-2 banks origin country. If there is uncertainty about the type, it will be set to null. - `date_of_birth` string, date-time, nullable, required — The employee’s date of birth. - `start_date` string, date-time, nullable, required — The date the employee started working for the organization. - `termination_date` string, date-time, nullable, required — The date when the employment ends. Can be in the past or future. - `remote_created_at` string, date-time, nullable, required — The date and time the object was created in the remote system. - `changed_at` string, date-time, required — The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated. - `remote_deleted_at` string, date-time, nullable, required — The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear. - `remote_data` object, nullable, required — Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it. - `warnings` object[], required — These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console. - `message` string, required ## Other responses - `default` — The standard error response with the error codes for the HRIS use case. --- [API](https://skmtc.net/kombo/apis/kombo-api.md) · [All operations](https://skmtc.net/kombo/apis/kombo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kombo/kombo-api/revisions/4700ff777f86/schema)