Authorizations
Headers
ID of the integration you want to interact with.
Path Parameters
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)
Body
PATCH /hris/employees/:employee_id Request body
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.
The first name of the employee.
The last name of the employee.
The gender of the employee.
MALE, FEMALE, NON_BINARY, NOT_SPECIFIED The title of the position this person is working in.
The employee's home address.
The employee's date of birth. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.
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 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.
The Kombo ID of the legal entity the employee should be in. This field is required for certain integrations.
The Kombo ID of the location the employee should be in. This field is required for certain integrations.
Additional fields that we will pass through to specific HRIS systems.
The social security number of the employee.
The marital status of an employee.
SINGLE, MARRIED, DOMESTIC_PARTNERSHIP, WIDOWED, DIVORCED, SEPARATED, NOT_MARRIED 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 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
PATCH /hris/employees/:employee_id Positive response
"success"{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"employee_number": "3243422",
"first_name": "John",
"last_name": "Doe",
"nationality": "French",
"display_full_name": "John Doe",
"job_title": "Integrations Team Lead",
"work_email": "john.doe@acme.com",
"personal_email": "john@doe.me",
"mobile_phone_number": "801-555-4687",
"ssn": "555-32-6395",
"tax_id": "12 345 678 901",
"gender": "MALE",
"ethnicity": "BLACK_AFRICAN_AMERICAN",
"marital_status": "MARRIED",
"employment_status": "INACTIVE",
"employment_type": "FULL_TIME",
"weekly_hours": 40,
"avatar": "https://resources.bamboohr.com/images/photo_person_150x150.png",
"work_location_id": "7E2gyuv6TmvtByzBxW9Sxt53",
"legal_entity_id": "xB32bied320csBSsl3XWdlw33",
"manager_id": "9pf2pxBB8VX8EQMC9aipW2Bo",
"home_address": {
"city": "Berlin",
"country": "DE",
"raw": "Sonnenallee 63\n12045 Berlin\nGermany",
"state": "Berlin",
"street_1": "Sonnenallee 63",
"street_2": null,
"zip_code": "12045"
},
"bank_accounts": [
{
"account_number": "1234567890",
"bank_name": "Commerzbank",
"bic": "COBADEFFXXX",
"domestic_bank_routing": {
"number": "34567890",
"type": "DE_BANKLEITZAHL"
},
"holder_name": "John Doe",
"iban": "DE12345678901234567890"
}
],
"date_of_birth": "1986-01-01T00:00:00.000Z",
"start_date": "2020-04-07T00:00:00.000Z",
"termination_date": "2022-05-20T00:00:00.000Z",
"remote_created_at": "2020-04-07T12:32:01.000Z",
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"remote_data": null
}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.