Sign in

v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified HRIS API

Update employee

Update an employee.

<Note> This endpoint requires the permission **Create and manage employees** to be enabled in [your scope config](/scopes). </Note>

Example Request Body

{
  "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"
  }
}
patch/hris/employees/{employee_id}

Path parameters

employee_idstring 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)

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-Idstring required

ID of the integration you want to interact with.

Request body

first_namestring

The first name of the employee.

last_namestring

The last name of the employee.

work_emailstring 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_titlestring

The title of the position this person is working in.

date_of_birthstring 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_numberstring
home_phone_numberstring
nationalitystring

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_datestring 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_idstring

The Kombo ID of the legal entity the employee should be in. This field is required for certain integrations.

location_idstring

The Kombo ID of the location the employee should be in. This field is required for certain integrations.

ssnstring

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_datestring 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_idstring

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

status'success' required

Example response

{
  "data": {
    "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
  }
}