Update an employee

patch

https://sandbox.checkhq.com/employees/{employee}

Updates the specified employee.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

employee

string

required

ID of the employee to update

Body Params

first_name

string

Employee’s first name

middle_name

string

Employee’s middle name

last_name

string

Employee’s last name

string

Employee’s email address

dob

date

Employee’s date of birth

residence

object

Employee residence used for calculating state income taxes

start_date

date

Most recent start date of employment

termination_date

date

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

default_net_pay_split

string

ID of the employee's net pay split

workplaces

array of strings

IDs of workplaces where the employee works

workplaces

primary_workplace

string

The Workplace ID of the employee's primary workplace.

ssn

string

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_preference

string

Either "direct_deposit" or "manual"

active

boolean

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

w2_electronic_consent_provided

boolean

Defaults to false

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

metadata

json

Additional loosely structured information to associate with the employee

Response

200200