Update Company Information

patch

https://api.zeal.com/companies

Update the Company Object

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint patches company information and returns the updated Company Object
Only the company object parameters outlined in this API reference are able to be patched via this endpoint

Returns

attribute	type	description
success	boolean	Response status
data	object	The newly updated Company Object
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

Body Params

companyID

string

required

Company ID of the employer (you can access companyID on the Zeal dashboard)

first_name

string

First name of business owner or administrator.

last_name

string

Last name of business owner or administrator.

string

Email address of business.

business_name

string

Business Name of company

business_phone

string

Phone number of company

business_address

string

Street address of company's business address

business_city

string

City of company's business address

business_state

string

State of company's business address

business_zip

string

Zip code of company's business address

mail_address

string

Mailing address of company

mail_city

string

Mailing city of company

mail_state

string

Mailing state of company

mail_zip

string

Mailing zip code of company

ssn

string

SSN of the primary business owner.

ownership_percentage

int32

The ownership percentage held by the primary business owner.

legal_structure

string

enum

The legal structure of the business.

job_title

string

The job title of the primary business owner.

dob

string

Date of birth of the primary business owner. This should be in theMM/DD/YYYY format.

address

string

Address of the primary business owner.

address_line2

string

Address line 2 of the primary business owner.

city

string

City of the primary business owner.

state

string

State of the primary business owner.

zip

string

Zip code of the primary business owner.

payroll_schedule

string

enum

The default payroll schedule that the company follows

Allowed:

payroll_firstDate

string

The ISO-8601 date of the first regular payroll

payroll_firstPayPeriodID

string

Reporting period ID of the first regular payroll

Responses

Returns

200200

400400