Update employee

PATCH/v1/employees/{employee_id}

Updates employee personal, contact, address, and employment fields. This endpoint currently supports email, phone, gender, address, employee_class, start_date, and compensation_type. effective_date is required and applies to employee_class and compensation_type when those fields are included in the request.

Path ParametersExpand Collapse

employee_id: string

Unique employee identifier (empl_*)

Body ParametersJSONExpand Collapse

effective_date: string

Past or present date applied to each tracked employment field included in this request

formatdate

address: optional { 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

compensation_type: optional "Salary" or "Hourly"

Salary - Salary
Hourly - Hourly

One of the following:

"Salary"

"Hourly"

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

One of the following:

"Full Time"

"Part Time"

"Temporary"

"Intern"

"Seasonal"

"Individual Contractor"

gender: optional "Male" or "Female" or "Transgender" or 2 more

Male - Male
Female - Female
Transgender - Transgender
Non-binary - Non Binary
Prefer not to respond - Prefer Not To Respond

One of the following:

"Male"

"Female"

"Transgender"

"Non-binary"

"Prefer not to respond"

phone: optional string

Phone number

start_date: optional string

Employment start date

formatdate

ReturnsExpand Collapse

data: Employee { id, classification_effective_date, compensation_type, 20 more }

id: string

Unique employee identifier with ‘empl_’ prefix

classification_effective_date: string

Date the employee’s current classification took effect

formatdate

compensation_type: "Salary" or "Hourly"

Salary - Salary
Hourly - Hourly

One of the following:

"Salary"

"Hourly"

compensation_type_effective_date: string

Date the employee’s current compensation type took effect

formatdate

created_at: string

Timestamp when the employee was created

formatdate-time

date_of_birth: string

Date of birth (YYYY-MM-DD)

formatdate

deductions: array of { benefit_name, deduction_amount_in_cents, deduction_category, 4 more }

Payroll deductions from the most recent statement period. Replaced when a new statement is generated.

benefit_name: string

Name of the benefit plan

deduction_amount_in_cents: number

Employee deduction amount in cents

deduction_category: string

Deduction category (reserved for future use)

frequency: "weekly" or "bi_weekly" or "semi_monthly" or "monthly"

weekly - Weekly
bi_weekly - Bi Weekly
semi_monthly - Semi Monthly
monthly - Monthly

One of the following:

"weekly"

"bi_weekly"

"semi_monthly"

"monthly"

period_end_date: string

Period end date (YYYY-MM-DD)

formatdate

period_start_date: string

Period start date (YYYY-MM-DD)

formatdate

tax_classification: "Unknown" or "Pre-tax" or "Post-tax"

Unknown - Unknown
Pre-tax - Pre Tax
Post-tax - Post Tax

One of the following:

"Unknown"

"Pre-tax"

"Post-tax"

email: string

Email address

formatemail

employee_class: EmployeeClass

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

One of the following:

"Full Time"

"Part Time"

"Temporary"

"Intern"

"Seasonal"

"Individual Contractor"

employer_id: string

Unique identifier of the employer this employment is with (empr_*)

first_name: string

Employee’s legal first name

last_name: string

Employee’s legal last name

member_id: string

Unique member identifier with ‘mbr_’ prefix

phone: string

Phone number (10-digit US domestic string)

start_date: string

Employee’s start date with the employer

formatdate

status: "active" or "terminated"

Employee status (active or terminated)

One of the following:

"active"

"terminated"

updated_at: string

Timestamp when the employee was last updated

formatdate-time

address: optional { address_line_1, city, state, 2 more }

Employee’s residential address

address_line_1: string

Primary street address

city: string

City name

state: string

Two-letter state code (e.g., CA, NY)

zipcode: string

ZIP code (5 or 9 digit)

address_line_2: optional string

Secondary street address (apt, suite, etc.)

employer_name: optional string

Name of the employer this employment is with

gender: optional string

Gender identity, if provided

reference_id: optional string

Partner-assigned reference ID for the employee

suffix: optional string

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

termination_date: optional string

Employee’s termination date, if terminated

formatdate

Update employee

curl https://api.vitablehealth.com/v1/employees/$EMPLOYEE_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY" \
    -d '{
          "effective_date": "2023-03-01"
        }'

{
  "data": {
    "id": "id",
    "classification_effective_date": "2019-12-27",
    "compensation_type": "Salary",
    "compensation_type_effective_date": "2019-12-27",
    "created_at": "2019-12-27T18:11:19.117Z",
    "date_of_birth": "2019-12-27",
    "deductions": [
      {
        "benefit_name": "benefit_name",
        "deduction_amount_in_cents": 0,
        "deduction_category": "deduction_category",
        "frequency": "weekly",
        "period_end_date": "2019-12-27",
        "period_start_date": "2019-12-27",
        "tax_classification": "Unknown"
      }
    ],
    "email": "dev@stainless.com",
    "employee_class": "Full Time",
    "employer_id": "employer_id",
    "first_name": "first_name",
    "last_name": "last_name",
    "member_id": "member_id",
    "phone": "phone",
    "start_date": "2019-12-27",
    "status": "active",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "address": {
      "address_line_1": "address_line_1",
      "city": "city",
      "state": "state",
      "zipcode": "zipcode",
      "address_line_2": "address_line_2"
    },
    "employer_name": "employer_name",
    "gender": "gender",
    "reference_id": "reference_id",
    "suffix": "suffix",
    "termination_date": "2019-12-27"
  }
}

Returns Examples

{
  "data": {
    "id": "id",
    "classification_effective_date": "2019-12-27",
    "compensation_type": "Salary",
    "compensation_type_effective_date": "2019-12-27",
    "created_at": "2019-12-27T18:11:19.117Z",
    "date_of_birth": "2019-12-27",
    "deductions": [
      {
        "benefit_name": "benefit_name",
        "deduction_amount_in_cents": 0,
        "deduction_category": "deduction_category",
        "frequency": "weekly",
        "period_end_date": "2019-12-27",
        "period_start_date": "2019-12-27",
        "tax_classification": "Unknown"
      }
    ],
    "email": "dev@stainless.com",
    "employee_class": "Full Time",
    "employer_id": "employer_id",
    "first_name": "first_name",
    "last_name": "last_name",
    "member_id": "member_id",
    "phone": "phone",
    "start_date": "2019-12-27",
    "status": "active",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "address": {
      "address_line_1": "address_line_1",
      "city": "city",
      "state": "state",
      "zipcode": "zipcode",
      "address_line_2": "address_line_2"
    },
    "employer_name": "employer_name",
    "gender": "gender",
    "reference_id": "reference_id",
    "suffix": "suffix",
    "termination_date": "2019-12-27"
  }
}