API Reference
Become a partner

Update an entitlement entry for an employee

put
https://api.hibob.com/v1/people//entitlement/

Updates an existing entitlement entry for the given employee. Send the full row (not a partial patch). Returns no content on success.

Required permissions: People's Data > Payroll > Manage selected employees' Payroll sections (or Entitlement table Manage when field-level permissions are enabled).

Path Params
string
required

Employee ID.

int64
required

The entry ID to update.

Body Params

Values for the entitlement entry you want to update.

Request body for creating or updating an entitlement entry. Do not send id; the system assigns it on create. On update, identify the row with the path {entry_id}.

date
required

Start of this timeline step (ISO 8601 date).

string
required

Entitlement type name from the company entitlement type list (for example Lunch vouchers or Company Car). To list available values, call the Get company list by name endpoint with the entitlement type list name.

amount
object
required
date

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

Responses
204

Entry updated successfully.

404

No entitlement entry was found for the given employee and entry ID.

Updated 3 days ago

Did this page help you?
Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 3 days ago

Did this page help you?