Update employee

put/v1/employees/{employee_id}

Updates an existing employee's information. All fields are optional - only provided fields will be updated. Note: SSN, name, date of birth, and sex cannot be changed after creation.

Path ParametersExpand Collapse

employee_id: string

Body ParametersExpand Collapse

address: optional object { city, state, street_1, 3 more }

Employee's residential address

city: string

City name

state: string

Two-letter state code

maxLength2

minLength2

street_1: string

Primary street address

zip_code: string

ZIP code

country: optional string

Country code

street_2: optional string

Secondary street address

email: optional string

Email address

formatemail

employee_class: optional EmployeeClass

Full Time - Full Time
Part Time - Part Time
Temporary - Temporary
Intern - Intern
Seasonal - Seasonal
Individual Contractor - Individual Contractor

Accepts one of the following:

"Full Time"

"Part Time"

"Temporary"

"Intern"

"Seasonal"

"Individual Contractor"

gender: optional string

Gender identity

phone: optional string

Phone number

termination_date: optional string

Termination date if terminating

formatdate

ReturnsExpand Collapse

Employee = object { id, active, created_at, 7 more }

Serializer for Employee entity in public API responses.

Note: Employee is in the company module but exposed via account public API. Contains nested MemberEntity with personal identity information.

id: string

Unique employee identifier with 'empl_' prefix

active: boolean

Whether the employee is currently active

created_at: string

Timestamp when the employee was created

formatdate-time

employer_id: string

ID of the employer this employee works for (empr_*)

member: object { id, date_of_birth, first_name, 6 more }

Nested member entity containing personal identity information.

Matches MemberEntity from account module domain.

id: string

Unique member identifier with 'mbr_' prefix

date_of_birth: string

Member's date of birth (YYYY-MM-DD)

formatdate

first_name: string

Member's legal first name

last_name: string

Member's legal last name

sex: Sex

Male - Male
Female - Female
Other - Other
Unknown - Unknown

Accepts one of the following:

"Male"

"Female"

"Other"

"Unknown"

email: optional string

Email address for communications

formatemail

gender: optional string

Gender identity, if provided

phone: optional string

Phone number

suffix: optional string

Name suffix (e.g., Jr., Sr., III)

start_date: string

Employee's start/hire date with the employer

formatdate

updated_at: string

Timestamp when the employee was last updated

formatdate-time

address: optional object { city, state, street_1, 3 more }

Nested address for employee.

city: string

City name

state: string

Two-letter state code

street_1: string

Primary street address

zip_code: string

ZIP code

country: optional string

Country code

street_2: optional string

Secondary street address

employee_class: optional EmployeeClass

Full Time - Full Time
Part Time - Part Time
Temporary - Temporary
Intern - Intern
Seasonal - Seasonal
Individual Contractor - Individual Contractor

Accepts one of the following:

"Full Time"

"Part Time"

"Temporary"

"Intern"

"Seasonal"

"Individual Contractor"

termination_date: optional string

Employee's termination date, if terminated

formatdate

Update employee

curl https://api.vitablehealth.com/v1/employees/$EMPLOYEE_ID \
    -X PUT \
    -H "Authorization: Bearer $VITABLE_connect_API_API_KEY"

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "employer_id": "employer_id",
  "member": {
    "id": "id",
    "date_of_birth": "2019-12-27",
    "first_name": "first_name",
    "last_name": "last_name",
    "sex": "Male",
    "email": "dev@stainless.com",
    "gender": "gender",
    "phone": "phone",
    "suffix": "suffix"
  },
  "start_date": "2019-12-27",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "address": {
    "city": "city",
    "state": "state",
    "street_1": "street_1",
    "zip_code": "zip_code",
    "country": "country",
    "street_2": "street_2"
  },
  "employee_class": "Full Time",
  "termination_date": "2019-12-27"
}

Returns Examples

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "employer_id": "employer_id",
  "member": {
    "id": "id",
    "date_of_birth": "2019-12-27",
    "first_name": "first_name",
    "last_name": "last_name",
    "sex": "Male",
    "email": "dev@stainless.com",
    "gender": "gender",
    "phone": "phone",
    "suffix": "suffix"
  },
  "start_date": "2019-12-27",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "address": {
    "city": "city",
    "state": "state",
    "street_1": "street_1",
    "zip_code": "zip_code",
    "country": "country",
    "street_2": "street_2"
  },
  "employee_class": "Full Time",
  "termination_date": "2019-12-27"
}