HIhibob
Employee Tables

Update an entitlement entry for an employee

Changed on

Updates an existing entitlement entry for the given employee. Send the full row (not a partial patch). Returns no content on success.<br /><br /> Required permissions: People's Data > People's fields > Entitlement (Table) > Edit.

put/people/{id}/entitlement/{entry_id}

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/people/{id}/entitlement/{entry_id}
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

idstring required

Employee ID.

entry_idinteger required

The entry ID to update.

Request body

effectiveDatestring date required

Start of this timeline step (ISO 8601 date).

entitlementstring required

Entitlement type name from the company entitlement type list (for example Lunch vouchers or Company Car). To list available values, call the <a href="https://apidocs.hibob.com/reference/get_company-named-lists-listname" target="_blank">Get company list by name</a> endpoint with list name entitlementType.

endDatestring date

Optional explicit end date for this entitlement period (ISO 8601 date).

customColumnsobject

Custom column values for this entry, keyed by column id.

Response

Entry updated successfully.

Changes