API Reference
Become a partner

Update a right to work entry for an employee

put
https://api.hibob.com/v1/people//right-to-work/

Updates an existing right to work entry for the given employee. Returns no content on success. Also updates the employee's financial.rightToWorkExpiryDate field.

Required permissions: People's Data > People's fields > Right to Work > Edit.

Path Params
string
required

Employee ID.

int64
required

The entry ID to update.

Body Params

Values for the right to work entry you want to update.

A right to work table entry as returned in reads.

int64

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

string

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

number

ID of the document attached to this entry.

date

Document expiration date (ISO 8601 date).

string

Document or permit number.

string

Issuing authority.

date

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

date

Application date (ISO 8601 date).

Responses
204

Entry updated successfully.

404

No right to work entry was found for the given employee and entry ID.

Updated about 1 month ago

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

Updated about 1 month ago

Did this page help you?