Set Onboarded Status to True

Set an employee as onboarded.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

attributetypedescription
successbooleanResponse status
dataobjectUpdated employee object
errorsarrayIf success is false, errors contains a list of error objects.
Show child attributes message
type: string
description: Error messagestatus
type: number
description: HTTP response codecode
type: number
description: Error code (see Error codes )
Body Params
string
required

ID of the Employee being updated

string
required

ID of the employer that the employee belongs to

Responses

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