Send Employee Onboarding Link
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
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.
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | object | Employee onboarding link |
| 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 ) |
companyID
string
required
Company ID of employer
employees
array of objects
Array of Employee objects to be sent onboarding links.
employees
ADD object
``200 200
``400 400
ShellNodeRubyPHPPython
xxxxxxxxxx
curl --request POST \
--url https://api.zeal.com/sendLink \
--header 'accept: application/json' \
--header 'content-type: application/json'
Click Try It! to start a request and see the response here! Or choose an example:
application/json
200 - Result400 - Result