Update company employee.

This endpoint allows you to update specific fields in an employee's record in Bob.

Important: Although this is a PUT method, it behaves like a PATCH request—you only need to send the fields you want to update, and any other fields will remain unchanged.

Before using this endpoint, read the instructions on how to update employee data. You can find them here: Update Employee data.

Notes:

  1. Only employee fields are supported; table updates are not allowed via this endpoint.
  2. Position fields cannot be updated using this endpoint.

Path Params
string
required

The backend-if of the Employee. Retrieve this ID from the database.
For testing purposes, you can pull it from the URL in Bob when viewing the employee. For example, if the URL in Bob is "https://app.hibob.com/employee-profile/3332883884017713238" you should copy the "3332883884017713238".

Body Params

Use Fields Metadata API for available field definitions.

Specify the field IDs you want to update, and their values.
Ensure to specify the field ID in the correct format - you can copy the correct format from the result of the People Search endpoint. Please read the instructions here: Update Employee data.

Important note: We recommend testing this endpoint using an external tool, such as Postman, rather than the 'Try It!' feature in the documentation. This is because the parameters need to be constructed in a specific format. The easiest way to do this is by copying the parameter structure from the 'Search' endpoint's response.

For example:
{
"home": {

"mobilePhone": "63635356"
},

"firstName": "Jacky"
}

Responses
200

Employee record was updated successfully.

304

Returned when employee data has not been modified. Ensure that the data being sent is new and that the correct field ID and JSON structure are being used.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!