HIhibob
Employee Tables

Create a right to work entry for an employee

Changed on

Creates a new right to work entry for the employee. On success, returns the new entry id. Creating, updating, or deleting entries also updates the employee's financial.rightToWorkExpiryDate field (an employee field you can fetch with the <a href="https://apidocs.hibob.com/reference/post_people-search" target="_blank">People search</a> endpoint).<br /><br /> Required permissions: People's Data > People's fields > Right to Work > Edit.

post/people/{id}/right-to-work

Request

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

Path parameters

idstring required

Employee ID.

Request body

typestring

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

documentIdnumber

ID of the document attached to this entry. Upload files via the Docs API and reference the returned document id here.

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 created successfully.

entryIdinteger required

The id of the newly created right to work table entry.

Changes