v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
People

Update company employee.

This endpoint allows you to update specific fields in an employee's record in Bob. <br /><br />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. <br /> <br /> Before using this endpoint, read the instructions on how to update employee data. You can find them here: <a href="https://apidocs.hibob.com/docs/update-employee-data">Update Employee data</a>. <br /><br />Notes: <ol> <li>Only employee fields are supported; table updates are not allowed via this endpoint.</li> <li>Position fields cannot be updated using this endpoint.</li> <li>Recently updated employee data may take a few seconds to become available when fetching data. If you read immediately after an update, the response may still show the previous value or <code>null</code>. Wait up to <b>20 seconds</b> before a follow-up read. See <a href="https://apidocs.hibob.com/docs/people-read-api-contract#read-after-update-consistency" target="_blank">Read-after-update consistency</a>.</li> </ol>

put/people/{identifier}

Path parameters

identifierstring required

The backend-if of the Employee. Retrieve this ID from the database.<br> 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".

Request body

object required

Specify the field IDs you want to update, and their values. <br /> 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: <a href="https://apidocs.hibob.com/docs/update-employee-data">Update Employee data</a>. <br><br> 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. <br><br> For example:<br> {<br> "home": {<br>
"mobilePhone": "63635356"<br> },<br><br> "firstName": "Jacky"<br> }

Example request

{
  "firstName": "Bob",
  "personal": {
    "birthDate": "2002-01-01"
  },
  "about": {
    "hobbies": [
      "music",
      "travel",
      "sport"
    ]
  }
}

Response

Employee record was updated successfully.