Create a right to work entry for an employee

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 People search endpoint).

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

Path Params
string
required

Employee ID.

Body Params

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

Request body for creating a right to work entry. Do not send id; the system assigns it on create.

string

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

number

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

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).

Response

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json