Set Onboarded Status to True
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
Set onboarded status to true if the employee has all the legally required information. If the employee does not have the aforementioned properties, Zeal will return an array of errors stating which properties are missing.
Returns Skip link to Returns
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | object | Updated employee object |
| errors | array | If success is false, errors contains a list of error objects. Show child attributes message type: string description: Error message status type: number description: HTTP response code code type: number description: Error code (see Error codes ) |
employeeID
string
required
ID of the Employee being updated
companyID
string
required
ID of the employer that the employee belongs to
``200 200
``400 400
Updated about 1 year ago
ShellNodeRubyPHPPython
xxxxxxxxxx
curl --request POST \
--url https://api.zeal.com/employees/setOnboardedStatusToTrue \
--header 'accept: application/json' \
--header 'content-type: application/json'
application/json
200 - Result400 - Result
Updated about 1 year ago