Employee Onboarding
Set Onboarded Status to True
Set an employee as onboarded.
POST
/
employees
/
setOnboardedStatusToTrue
Set Onboarded Status to True
curl --request POST \
--url https://api.zeal.com/employees/setOnboardedStatusToTrue \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"employeeID": "62350595e7f1225023b3b824",
"companyID": "24b5b29f07924840b119c34c13522940c"
}
'import requests
url = "https://api.zeal.com/employees/setOnboardedStatusToTrue"
payload = {
"employeeID": "62350595e7f1225023b3b824",
"companyID": "24b5b29f07924840b119c34c13522940c"
}
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({
employeeID: '62350595e7f1225023b3b824',
companyID: '24b5b29f07924840b119c34c13522940c'
})
};
fetch('https://api.zeal.com/employees/setOnboardedStatusToTrue', 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/employees/setOnboardedStatusToTrue",
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([
'employeeID' => '62350595e7f1225023b3b824',
'companyID' => '24b5b29f07924840b119c34c13522940c'
]),
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/employees/setOnboardedStatusToTrue"
payload := strings.NewReader("{\n \"employeeID\": \"62350595e7f1225023b3b824\",\n \"companyID\": \"24b5b29f07924840b119c34c13522940c\"\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/employees/setOnboardedStatusToTrue")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employeeID\": \"62350595e7f1225023b3b824\",\n \"companyID\": \"24b5b29f07924840b119c34c13522940c\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/setOnboardedStatusToTrue")
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 \"employeeID\": \"62350595e7f1225023b3b824\",\n \"companyID\": \"24b5b29f07924840b119c34c13522940c\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"employeeID": "633c323231018d840022913ca6",
"companyID": "2cb5b29f0792634128c34c1358940c",
"onboarded": true,
"employment_status": "live",
"first_name": "Erlich",
"middle_initial": null,
"last_name": "Bachman",
"title": "4345",
"start_date": "2019-11-01",
"term_date": null,
"working_state": "CA",
"workLocationID": "6142deeb548f55223a0c67",
"dob": "1825-10-02",
"email": "erlich@test.com",
"address": "1 Ferry Building",
"address_line2": "",
"city": "San Francisco",
"state": "CA",
"zip": "94105",
"phone_number": "12345",
"default_pay_schedule": "weekly",
"default_wage": 5,
"default_ot_wage": 100,
"default_dt_wage": 100,
"ssn": "000000000",
"autopilot": {
"autopilot_on": true,
"salary": 30000,
"salary_firstDate": "2022-10-06"
},
"is_943": true,
"is_scheduleH": false,
"metadata": {}
}
}{
"success": false,
"errors": [
{
"message": "Employee is already onboarded",
"status": 400,
"code": 38
}
]
}⌘I
Set Onboarded Status to True
curl --request POST \
--url https://api.zeal.com/employees/setOnboardedStatusToTrue \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"employeeID": "62350595e7f1225023b3b824",
"companyID": "24b5b29f07924840b119c34c13522940c"
}
'import requests
url = "https://api.zeal.com/employees/setOnboardedStatusToTrue"
payload = {
"employeeID": "62350595e7f1225023b3b824",
"companyID": "24b5b29f07924840b119c34c13522940c"
}
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({
employeeID: '62350595e7f1225023b3b824',
companyID: '24b5b29f07924840b119c34c13522940c'
})
};
fetch('https://api.zeal.com/employees/setOnboardedStatusToTrue', 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/employees/setOnboardedStatusToTrue",
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([
'employeeID' => '62350595e7f1225023b3b824',
'companyID' => '24b5b29f07924840b119c34c13522940c'
]),
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/employees/setOnboardedStatusToTrue"
payload := strings.NewReader("{\n \"employeeID\": \"62350595e7f1225023b3b824\",\n \"companyID\": \"24b5b29f07924840b119c34c13522940c\"\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/employees/setOnboardedStatusToTrue")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"employeeID\": \"62350595e7f1225023b3b824\",\n \"companyID\": \"24b5b29f07924840b119c34c13522940c\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/setOnboardedStatusToTrue")
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 \"employeeID\": \"62350595e7f1225023b3b824\",\n \"companyID\": \"24b5b29f07924840b119c34c13522940c\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"employeeID": "633c323231018d840022913ca6",
"companyID": "2cb5b29f0792634128c34c1358940c",
"onboarded": true,
"employment_status": "live",
"first_name": "Erlich",
"middle_initial": null,
"last_name": "Bachman",
"title": "4345",
"start_date": "2019-11-01",
"term_date": null,
"working_state": "CA",
"workLocationID": "6142deeb548f55223a0c67",
"dob": "1825-10-02",
"email": "erlich@test.com",
"address": "1 Ferry Building",
"address_line2": "",
"city": "San Francisco",
"state": "CA",
"zip": "94105",
"phone_number": "12345",
"default_pay_schedule": "weekly",
"default_wage": 5,
"default_ot_wage": 100,
"default_dt_wage": 100,
"ssn": "000000000",
"autopilot": {
"autopilot_on": true,
"salary": 30000,
"salary_firstDate": "2022-10-06"
},
"is_943": true,
"is_scheduleH": false,
"metadata": {}
}
}{
"success": false,
"errors": [
{
"message": "Employee is already onboarded",
"status": 400,
"code": 38
}
]
}