API ReferenceEmployees

Update

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.

Authentication

AuthorizationBearer

API Key or Access Token authentication using Bearer token in Authorization header. API keys use the vit_apk_ prefix, access tokens use the vit_at_ prefix.

Path parameters

employee_idstringRequired

Unique employee identifier (empl_*)

Request

This endpoint expects an object.
effective_datedateRequired
Past or present date applied to each tracked employment field included in this request
emailstring or nullOptionalformat: "email"
Email address
phonestring or nullOptional
Phone number
genderenum or nullOptional

Gender identity

  • Male - Male
  • Female - Female
  • Transgender - Transgender
  • Non-binary - Non-binary
  • Prefer not to respond - Prefer not to respond
addressobject or nullOptional
Employee's residential address
employee_classenum or nullOptional

Employment classification

  • Full Time - Full Time
  • Part Time - Part Time
  • Temporary - Temporary
  • Intern - Intern
  • Seasonal - Seasonal
  • Individual Contractor - Individual Contractor
start_datedate or nullOptional
Employment start date
compensation_typeenum or nullOptional

Employee compensation type

  • Salary - Salary
  • Hourly - Hourly

Response headers

X-RateLimit-Limitinteger
Maximum number of requests allowed within the rate limit window
X-RateLimit-Remaininginteger
Number of requests remaining in the current rate limit window
X-RateLimit-Resetinteger

Unix timestamp (seconds) when the rate limit window resets

Response

dataobject
The employee record.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error