Employees

Update employee

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.

patch/v1/employees/{employee_id}

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/employees/{employee_id}
  • Auth: HTTP bearer

Path parameters

employee_idstring required

Unique employee identifier (empl_*)

Request body

emailstring email nullable

Email address

phonestring nullable

10-digit US phone number; formatting characters and a leading 1 are ignored

gender'Male' | 'Female' | 'Transgender' | 'Non-binary' | 'Prefer not to respond'
  • Male - Male
  • Female - Female
  • Transgender - Transgender
  • Non-binary - Non-binary
  • Prefer not to respond - Prefer not to respond
employee_class'Full Time' | 'Part Time' | 'Temporary' | 'Intern' | 'Seasonal' | 'Individual Contractor'
  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor
start_datestring date nullable

Employment start date

compensation_type'Salary' | 'Hourly'
  • Salary - Salary
  • Hourly - Hourly
effective_datestring date required

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

Response

Changes

No recorded changes to this operation across all 1 revision of this API.