Employee Onboarding
Send Employee Onboarding Link
Sends an employee onboarding link to the specified employee’s email in Zeal.
POST
/
sendLink
Send Employee Onboarding Link
curl --request POST \
--url https://api.zeal.com/sendLink \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "1eeec343485723ee58ufefhz",
"employees": [
{
"profile": false,
"employee_acct": false,
"i9_form": false,
"id_scan": false,
"paperwork": false,
"employeeID": "cc4482374ee49487ruzieun"
},
{
"profile": true,
"employee_acct": false,
"i9_form": false,
"id_scan": false,
"paperwork": false,
"employeeID": "dd5582374ee494ccru998eun"
}
]
}
'import requests
url = "https://api.zeal.com/sendLink"
payload = {
"companyID": "1eeec343485723ee58ufefhz",
"employees": [
{
"profile": False,
"employee_acct": False,
"i9_form": False,
"id_scan": False,
"paperwork": False,
"employeeID": "cc4482374ee49487ruzieun"
},
{
"profile": True,
"employee_acct": False,
"i9_form": False,
"id_scan": False,
"paperwork": False,
"employeeID": "dd5582374ee494ccru998eun"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '1eeec343485723ee58ufefhz',
employees: [
{
profile: false,
employee_acct: false,
i9_form: false,
id_scan: false,
paperwork: false,
employeeID: 'cc4482374ee49487ruzieun'
},
{
profile: true,
employee_acct: false,
i9_form: false,
id_scan: false,
paperwork: false,
employeeID: 'dd5582374ee494ccru998eun'
}
]
})
};
fetch('https://api.zeal.com/sendLink', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/sendLink",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '1eeec343485723ee58ufefhz',
'employees' => [
[
'profile' => false,
'employee_acct' => false,
'i9_form' => false,
'id_scan' => false,
'paperwork' => false,
'employeeID' => 'cc4482374ee49487ruzieun'
],
[
'profile' => true,
'employee_acct' => false,
'i9_form' => false,
'id_scan' => false,
'paperwork' => false,
'employeeID' => 'dd5582374ee494ccru998eun'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/sendLink"
payload := strings.NewReader("{\n \"companyID\": \"1eeec343485723ee58ufefhz\",\n \"employees\": [\n {\n \"profile\": false,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"cc4482374ee49487ruzieun\"\n },\n {\n \"profile\": true,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"dd5582374ee494ccru998eun\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/sendLink")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"1eeec343485723ee58ufefhz\",\n \"employees\": [\n {\n \"profile\": false,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"cc4482374ee49487ruzieun\"\n },\n {\n \"profile\": true,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"dd5582374ee494ccru998eun\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/sendLink")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"1eeec343485723ee58ufefhz\",\n \"employees\": [\n {\n \"profile\": false,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"cc4482374ee49487ruzieun\"\n },\n {\n \"profile\": true,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"dd5582374ee494ccru998eun\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"employeeID": "cc4482374ee49487ruzieun"
},
{
"employeeID": "dd5582374ee494ccru998eun"
}
]
}{
"success": false,
"errors": [
{
"message": "Employee with this employeeID does not exist",
"code": 23
}
]
}⌘I
Send Employee Onboarding Link
curl --request POST \
--url https://api.zeal.com/sendLink \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "1eeec343485723ee58ufefhz",
"employees": [
{
"profile": false,
"employee_acct": false,
"i9_form": false,
"id_scan": false,
"paperwork": false,
"employeeID": "cc4482374ee49487ruzieun"
},
{
"profile": true,
"employee_acct": false,
"i9_form": false,
"id_scan": false,
"paperwork": false,
"employeeID": "dd5582374ee494ccru998eun"
}
]
}
'import requests
url = "https://api.zeal.com/sendLink"
payload = {
"companyID": "1eeec343485723ee58ufefhz",
"employees": [
{
"profile": False,
"employee_acct": False,
"i9_form": False,
"id_scan": False,
"paperwork": False,
"employeeID": "cc4482374ee49487ruzieun"
},
{
"profile": True,
"employee_acct": False,
"i9_form": False,
"id_scan": False,
"paperwork": False,
"employeeID": "dd5582374ee494ccru998eun"
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '1eeec343485723ee58ufefhz',
employees: [
{
profile: false,
employee_acct: false,
i9_form: false,
id_scan: false,
paperwork: false,
employeeID: 'cc4482374ee49487ruzieun'
},
{
profile: true,
employee_acct: false,
i9_form: false,
id_scan: false,
paperwork: false,
employeeID: 'dd5582374ee494ccru998eun'
}
]
})
};
fetch('https://api.zeal.com/sendLink', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/sendLink",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '1eeec343485723ee58ufefhz',
'employees' => [
[
'profile' => false,
'employee_acct' => false,
'i9_form' => false,
'id_scan' => false,
'paperwork' => false,
'employeeID' => 'cc4482374ee49487ruzieun'
],
[
'profile' => true,
'employee_acct' => false,
'i9_form' => false,
'id_scan' => false,
'paperwork' => false,
'employeeID' => 'dd5582374ee494ccru998eun'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/sendLink"
payload := strings.NewReader("{\n \"companyID\": \"1eeec343485723ee58ufefhz\",\n \"employees\": [\n {\n \"profile\": false,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"cc4482374ee49487ruzieun\"\n },\n {\n \"profile\": true,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"dd5582374ee494ccru998eun\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/sendLink")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"1eeec343485723ee58ufefhz\",\n \"employees\": [\n {\n \"profile\": false,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"cc4482374ee49487ruzieun\"\n },\n {\n \"profile\": true,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"dd5582374ee494ccru998eun\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/sendLink")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"1eeec343485723ee58ufefhz\",\n \"employees\": [\n {\n \"profile\": false,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"cc4482374ee49487ruzieun\"\n },\n {\n \"profile\": true,\n \"employee_acct\": false,\n \"i9_form\": false,\n \"id_scan\": false,\n \"paperwork\": false,\n \"employeeID\": \"dd5582374ee494ccru998eun\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"employeeID": "cc4482374ee49487ruzieun"
},
{
"employeeID": "dd5582374ee494ccru998eun"
}
]
}{
"success": false,
"errors": [
{
"message": "Employee with this employeeID does not exist",
"code": 23
}
]
}