CHcheckhq

Update an employee

Changed on

Updates the specified employee.

patch/employees/{employee}

Request

Path parameters

employeestring required

ID of the employee to update

Request body

first_namestring

Employee’s first name

middle_namestring

Employee’s middle name

last_namestring

Employee’s last name

emailstring

Employee’s email address

dobstring date

Employee’s date of birth

start_datestring date

Most recent start date of employment

termination_datestring date

Most recent date of employment termination. Will be set to null if a more recent start date is set.

default_net_pay_splitstring

ID of the employee's net pay split

workplacesstring[]

IDs of workplaces where the employee works

primary_workplacestring

The Workplace ID of the employee's primary workplace.

ssnstring

Employee's TIN (usually their Social Security Number). Must be unique across all employees in a company. Only the last four digits of an SSN will be made available in ssn_last_four after being set.

payment_method_preferencestring

Either "direct_deposit" or "manual"

activeboolean

Indicates whether the employee is currently employed. Used only for filtering.

w2_electronic_consent_providedboolean

Indicates whether the employee has opted into electronic delivery of W2 PDF.

metadatastring json

Additional loosely structured information to associate with the employee

Response

200

Changes