Send Employee Onboarding Link

Sends an employee onboarding link to the specified employee's email.

Zeal will send the web onboarding link to the employee's email. See the above section for detailed information about Zeal's web onboarding flow. If you have a hosted URL set with Zeal, the onboarding link sent will contain your hosted URL as the domain.

If you use a Production Key, new employees will be emailed the onboarding link. If you use a Test Key, new employees will not be emailed the onboarding link.

Returns

Returns a success response and employee onboarding link.

attributetypedescription
successbooleanResponse status
dataobjectEmployee onboarding link
errorsarrayIf 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 )
Language
Authorization
Header
Click Try It! to start a request and see the response here!