> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Employee

> Update an employee’s personal data in the connected HRIS.

<Note>
  This feature is now in closed beta. Please reach out to your account manager
  or [support](mailto:support@kombo.dev).
</Note>

## Overview

**Update Employee** changes data that belongs to the employee, like their name or home address. Get the fields the HRIS accepts, collect the required values and any changes, then submit them.

Compensation and job belong to an employment, not the employee. To change them, use [Update Employment](/hris/features/update-employment). To bring back a former employee, use [Rehire Employee](/hris/features/rehire-employee).

Which fields the form has depends on the HRIS and how the company set it up.

## Implementation Steps

<Steps>
  <Step title="Get the form">
    `GET` [/hris/employees/\{employee\_id}/form/personal\_data](/hris/v1/get-employees-employee-id-form-personal-data).

    `employee_id` accepts the Kombo ID or the HRIS ID with a `remote:` prefix, for example `GET /hris/employees/remote:12345/form/personal_data`. If the HRIS can't make this change, you get `INTEGRATION.ACTION_NOT_AVAILABLE`, so you can hide the option in your UI.

    When available, `current_value` contains the field’s current value in the HRIS. Use it to prefill the form. `null` means the field is empty. If the HRIS doesn't let us read a field, `current_value` is left out.

    <Accordion title="Full form example">
      ```json Example Response theme={null}
      {
        "status": "success",
        "data": {
          "properties": {
            "lastName": {
              "label": "Last Name",
              "required": false,
              "description": "Employee's last name",
              "unified_key": "last_name",
              "type": "text",
              "reg_exp": null,
              "current_value": "Doe"
            },
            "homeCity": {
              "label": "City",
              "required": false,
              "description": "City of the employee's home address",
              "unified_key": "home_address.city",
              "type": "text",
              "reg_exp": null,
              "current_value": "Munich"
            },
            "homeAddressLine2": {
              "label": "Address Line 2",
              "required": false,
              "description": "Second line of the employee's home address",
              "unified_key": "home_address.street_2",
              "type": "text",
              "reg_exp": null,
              "current_value": "Apartment 4"
            }
          }
        },
        "warnings": []
      }
      ```
    </Accordion>
  </Step>

  <Step title="Submit changes">
    `PATCH` the values in `properties` to [the same URL](/hris/v1/patch-employees-employee-id-form-personal-data).

    Use the field keys returned by GET. Include required fields and any fields you want to change. Omitted fields stay unchanged; `null` clears a value.

    ```json Example Request theme={null}
    {
      "properties": {
        "homeCity": "Berlin",
        "homeAddressLine2": null
      }
    }
    ```

    <Accordion title="Rules for updates">
      * Options listed in the form accept the option `id` or `remote:<remote_id>`. For options returned by a linked endpoint (`options.type: "referenced"`), use the Kombo ID.
      * Dates use `YYYY-MM-DD`. Whether a past date is allowed depends on the HRIS.
    </Accordion>

    Requires the **Create and manage employees** permission in your [scopes](/hris/features/scopes).
  </Step>

  <Step title="Read the response">
    ```json Example Response theme={null}
    {
      "status": "success",
      "data": {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "12345"
      },
      "warnings": []
    }
    ```

    * **`id`**: The Kombo ID of the employee.
    * **`remote_id`**: The ID of the employee in the HRIS.

    A `success` response means the HRIS saved the change, and Kombo updates its copy of the employee right away.
  </Step>
</Steps>

<Card title="Displaying the Form" icon="book-open" href="/hris/implementation-guide/create-employee" arrow={true}>
  Reuse your create employee form display code. Submit values using the keys
  returned by the update form. This guide explains field types and mapping.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.