Companies
Update Company Information
Update an existing company’s business details, owner information, or payroll schedule.
PATCH
/
companies
Update Company Information
curl --request PATCH \
--url https://api.zeal.com/companies \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"business_name": "<string>",
"business_phone": "<string>",
"business_address": "<string>",
"business_city": "<string>",
"business_state": "<string>",
"business_zip": "<string>",
"mail_address": "<string>",
"mail_city": "<string>",
"mail_state": "<string>",
"mail_zip": "<string>",
"ssn": "<string>",
"ownership_percentage": 123,
"job_title": "<string>",
"dob": "<string>",
"address": "<string>",
"address_line2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"payroll_firstDate": "<string>",
"payroll_firstPayPeriodID": "<string>"
}
'import requests
url = "https://api.zeal.com/companies"
payload = {
"companyID": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"business_name": "<string>",
"business_phone": "<string>",
"business_address": "<string>",
"business_city": "<string>",
"business_state": "<string>",
"business_zip": "<string>",
"mail_address": "<string>",
"mail_city": "<string>",
"mail_state": "<string>",
"mail_zip": "<string>",
"ssn": "<string>",
"ownership_percentage": 123,
"job_title": "<string>",
"dob": "<string>",
"address": "<string>",
"address_line2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"payroll_firstDate": "<string>",
"payroll_firstPayPeriodID": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '<string>',
first_name: '<string>',
last_name: '<string>',
email: '<string>',
business_name: '<string>',
business_phone: '<string>',
business_address: '<string>',
business_city: '<string>',
business_state: '<string>',
business_zip: '<string>',
mail_address: '<string>',
mail_city: '<string>',
mail_state: '<string>',
mail_zip: '<string>',
ssn: '<string>',
ownership_percentage: 123,
job_title: '<string>',
dob: '<string>',
address: '<string>',
address_line2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
payroll_firstDate: '<string>',
payroll_firstPayPeriodID: '<string>'
})
};
fetch('https://api.zeal.com/companies', 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/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'business_name' => '<string>',
'business_phone' => '<string>',
'business_address' => '<string>',
'business_city' => '<string>',
'business_state' => '<string>',
'business_zip' => '<string>',
'mail_address' => '<string>',
'mail_city' => '<string>',
'mail_state' => '<string>',
'mail_zip' => '<string>',
'ssn' => '<string>',
'ownership_percentage' => 123,
'job_title' => '<string>',
'dob' => '<string>',
'address' => '<string>',
'address_line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'payroll_firstDate' => '<string>',
'payroll_firstPayPeriodID' => '<string>'
]),
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/companies"
payload := strings.NewReader("{\n \"companyID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"job_title\": \"<string>\",\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.zeal.com/companies")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"job_title\": \"<string>\",\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"job_title\": \"<string>\",\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"companyID": "1e2wu23273238c22ea2",
"first_name": "Richard",
"last_name": "Hendricks",
"email": "richard@piedpiper.com",
"business_name": "Pied Piper",
"business_address": "1 Market St.",
"business_city": "San Francisco",
"business_state": "CA",
"business_zip": "94110",
"business_phone": "2025550151",
"mail_address": "1 Market St.",
"mail_city": "San Francisco",
"mail_state": "CA",
"mail_zip": "94110",
"ssn": "22-333-4444",
"ownership_percentage": 25,
"dob": "01/01/1990",
"legal_structure": "ccorp",
"job_title": "CEO",
"address": "1 Ferry Building",
"city": "San francisco",
"state": "CA",
"zip": "94105",
"payroll_firstCheckDate": "2024-08-30",
"payroll_schedule": "weekly",
"payroll_firstPayPeriodID": "6580ce4a3808d60023b4e412"
}
}{
"success": false,
"errors": [
{
"message": "No user with this company ID exists",
"code": 4
}
]
}Patches company information and returns the updated Company Object. Only the company object fields documented in this API reference can be patched via this endpoint.
Authorizations
Body
application/json
Company ID of the employer (you can access companyID on the Zeal dashboard)
First name of business owner or administrator.
Last name of business owner or administrator.
Email address of business.
Business Name of company
Phone number of company
Street address of company's business address
City of company's business address
State of company's business address
Zip code of company's business address
Mailing address of company
Mailing city of company
Mailing state of company
Mailing zip code of company
SSN of the primary business owner.
The ownership percentage held by the primary business owner.
The legal structure of the business.
Available options:
ccorp, corp, estate, foreign_entity, llc, llp, lp, nonprofit, partnership, scheme, scorp, soleprop, trust The job title of the primary business owner.
Date of birth of the primary business owner. This should be in theMM/DD/YYYY format.
Address of the primary business owner.
Address line 2 of the primary business owner.
City of the primary business owner.
State of the primary business owner.
Zip code of the primary business owner.
The default payroll schedule that the company follows
Available options:
daily, weekly, biweekly, semimonthly, monthly The ISO-8601 date of the first regular payroll
Reporting period ID of the first regular payroll
⌘I
Update Company Information
curl --request PATCH \
--url https://api.zeal.com/companies \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"business_name": "<string>",
"business_phone": "<string>",
"business_address": "<string>",
"business_city": "<string>",
"business_state": "<string>",
"business_zip": "<string>",
"mail_address": "<string>",
"mail_city": "<string>",
"mail_state": "<string>",
"mail_zip": "<string>",
"ssn": "<string>",
"ownership_percentage": 123,
"job_title": "<string>",
"dob": "<string>",
"address": "<string>",
"address_line2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"payroll_firstDate": "<string>",
"payroll_firstPayPeriodID": "<string>"
}
'import requests
url = "https://api.zeal.com/companies"
payload = {
"companyID": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"business_name": "<string>",
"business_phone": "<string>",
"business_address": "<string>",
"business_city": "<string>",
"business_state": "<string>",
"business_zip": "<string>",
"mail_address": "<string>",
"mail_city": "<string>",
"mail_state": "<string>",
"mail_zip": "<string>",
"ssn": "<string>",
"ownership_percentage": 123,
"job_title": "<string>",
"dob": "<string>",
"address": "<string>",
"address_line2": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>",
"payroll_firstDate": "<string>",
"payroll_firstPayPeriodID": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '<string>',
first_name: '<string>',
last_name: '<string>',
email: '<string>',
business_name: '<string>',
business_phone: '<string>',
business_address: '<string>',
business_city: '<string>',
business_state: '<string>',
business_zip: '<string>',
mail_address: '<string>',
mail_city: '<string>',
mail_state: '<string>',
mail_zip: '<string>',
ssn: '<string>',
ownership_percentage: 123,
job_title: '<string>',
dob: '<string>',
address: '<string>',
address_line2: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>',
payroll_firstDate: '<string>',
payroll_firstPayPeriodID: '<string>'
})
};
fetch('https://api.zeal.com/companies', 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/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'email' => '<string>',
'business_name' => '<string>',
'business_phone' => '<string>',
'business_address' => '<string>',
'business_city' => '<string>',
'business_state' => '<string>',
'business_zip' => '<string>',
'mail_address' => '<string>',
'mail_city' => '<string>',
'mail_state' => '<string>',
'mail_zip' => '<string>',
'ssn' => '<string>',
'ownership_percentage' => 123,
'job_title' => '<string>',
'dob' => '<string>',
'address' => '<string>',
'address_line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>',
'payroll_firstDate' => '<string>',
'payroll_firstPayPeriodID' => '<string>'
]),
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/companies"
payload := strings.NewReader("{\n \"companyID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"job_title\": \"<string>\",\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.zeal.com/companies")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"job_title\": \"<string>\",\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"<string>\",\n \"business_name\": \"<string>\",\n \"business_phone\": \"<string>\",\n \"business_address\": \"<string>\",\n \"business_city\": \"<string>\",\n \"business_state\": \"<string>\",\n \"business_zip\": \"<string>\",\n \"mail_address\": \"<string>\",\n \"mail_city\": \"<string>\",\n \"mail_state\": \"<string>\",\n \"mail_zip\": \"<string>\",\n \"ssn\": \"<string>\",\n \"ownership_percentage\": 123,\n \"job_title\": \"<string>\",\n \"dob\": \"<string>\",\n \"address\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\",\n \"payroll_firstDate\": \"<string>\",\n \"payroll_firstPayPeriodID\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"companyID": "1e2wu23273238c22ea2",
"first_name": "Richard",
"last_name": "Hendricks",
"email": "richard@piedpiper.com",
"business_name": "Pied Piper",
"business_address": "1 Market St.",
"business_city": "San Francisco",
"business_state": "CA",
"business_zip": "94110",
"business_phone": "2025550151",
"mail_address": "1 Market St.",
"mail_city": "San Francisco",
"mail_state": "CA",
"mail_zip": "94110",
"ssn": "22-333-4444",
"ownership_percentage": 25,
"dob": "01/01/1990",
"legal_structure": "ccorp",
"job_title": "CEO",
"address": "1 Ferry Building",
"city": "San francisco",
"state": "CA",
"zip": "94105",
"payroll_firstCheckDate": "2024-08-30",
"payroll_schedule": "weekly",
"payroll_firstPayPeriodID": "6580ce4a3808d60023b4e412"
}
}{
"success": false,
"errors": [
{
"message": "No user with this company ID exists",
"code": 4
}
]
}