HIhibob
Employee Tables

Update a right to work entry for an employee

Changed on

Updates an existing right to work entry for the given employee. Returns no content on success. Also updates the employee's financial.rightToWorkExpiryDate field.<br /><br /> Required permissions: People's Data > People's fields > Right to Work > Edit.

put/people/{id}/right-to-work/{entry_id}

Request

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

Path parameters

idstring required

Employee ID.

entry_idinteger required

The entry ID to update.

Request body

idinteger

The id of the right to work entry. Assigned by the system on create.

typestring

Right to work document type (list value as stored in Bob).

documentIdnumber

ID of the document attached to this entry.

expirationDatestring date

Document expiration date (ISO 8601 date).

numberstring

Document or permit number.

issuedBystring

Issuing authority.

validFromstring date

Date from which the document is valid (ISO 8601 date).

applicationDatestring date

Application date (ISO 8601 date).

customColumnsobject

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

Response

Entry updated successfully.

Changes