> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.vitablehealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.vitablehealth.com/_mcp/server.

# Update

PATCH https://api.vitablehealth.com/v1/employees/{employee_id}
Content-Type: application/json

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.

Reference: https://developer.vitablehealth.com/api/employees/update

## Authentication

- `Authorization` header (bearer token, required) — 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.

## Servers

- `https://api.vitablehealth.com` (Production, default)
- `https://api.uat.vitablehealth.com` (UAT)

## Request

### Path parameters

- `employee_id` (string, required) — Unique employee identifier (empl_*)

### Body (application/json)

This endpoint expects a PatchedUpdateEmployeeRequest.

- `effective_date` (date, required) — Past or present date applied to each tracked employment field included in this request
- `email` (string, optional, nullable) — Email address
- `phone` (string, optional, nullable) — 10-digit US phone number; formatting characters and a leading 1 are ignored
- `gender` (enum, optional, nullable) — Gender identity * `Male` - Male * `Female` - Female * `Transgender` - Transgender * `Non-binary` - Non-binary * `Prefer not to respond` - Prefer not to respond
  - Allowed values: `Male`, `Female`, `Transgender`, `Non-binary`, `Prefer not to respond`
- `address` (EmployeeAddressInput, optional, nullable) — Employee's residential address
- `employee_class` (enum, optional, nullable) — Employment classification * `Full Time` - Full Time * `Part Time` - Part Time * `Temporary` - Temporary * `Intern` - Intern * `Seasonal` - Seasonal * `Individual Contractor` - Individual Contractor
  - Allowed values: `Full Time`, `Part Time`, `Temporary`, `Intern`, `Seasonal`, `Individual Contractor`
- `start_date` (date, optional, nullable) — Employment start date
- `compensation_type` (enum, optional, nullable) — Employee compensation type * `Salary` - Salary * `Hourly` - Hourly
  - Allowed values: `Salary`, `Hourly`

## Response

### 200

- `data` (Employee, required) — The employee record.

## Errors

### 400 Bad Request Error

Invalid request.

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 401 Unauthorized Error

Unauthorized - Invalid or missing API key

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 403 Forbidden Error

Forbidden - Insufficient permissions for this resource

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 404 Not Found Error

Resource not found.

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 409 Conflict Error

Conflict - Resource already exists or conflicts with current state

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 429 Too Many Requests Error

Too Many Requests - Rate limit exceeded

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 500 Internal Server Error

Internal Server Error - An unexpected error occurred

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

### 502 Bad Gateway Error

Bad Gateway - External service error

- `timestamp` (datetime, required) — ISO 8601 timestamp when the error occurred
- `message` (string, required) — Human-readable error message
- `error` (string, required) — Error message (same as message, for backwards compatibility)
- `trace_id` (string, required) — Unique trace ID for debugging and support requests
- `app_error_code` (string, optional, nullable) — Application-specific error code for programmatic handling

## Types

### EmployeeAddressInput

- `street_1` (string, required) — Primary street address
- `city` (string, required) — City name
- `state` (string, required) — Two-letter state code
- `zip_code` (string, required) — ZIP code
- `street_2` (string, optional, nullable) — Secondary street address
- `country` (string, optional, default: US) — Country code. Only US addresses are supported; the value is ignored.

### Employee

- `id` (string, required) — Unique employee identifier with 'empl_' prefix
- `member_id` (string, required) — Unique member identifier with 'mbr_' prefix
- `employer_id` (string, required) — Unique identifier of the employer this employment is with (empr_*)
- `first_name` (string, required) — Employee's legal first name
- `last_name` (string, required) — Employee's legal last name
- `email` (string, required) — Email address
- `date_of_birth` (date, required) — Date of birth (YYYY-MM-DD)
- `phone` (string, required, nullable) — Phone number (10-digit US domestic string)
- `employee_class` (enum, required) — Employment classification affecting benefit eligibility * `Full Time` - Full Time * `Part Time` - Part Time * `Temporary` - Temporary * `Intern` - Intern * `Seasonal` - Seasonal * `Individual Contractor` - Individual Contractor
  - Allowed values: `Full Time`, `Part Time`, `Temporary`, `Intern`, `Seasonal`, `Individual Contractor`
- `status` (enum, required) — Employee status (active or terminated)
  - Allowed values: `active`, `terminated`
- `start_date` (date, required) — Employee's start date with the employer
- `classification_effective_date` (date, required) — Date the employee's current classification took effect
- `compensation_type` (enum, required, nullable) — Employee's compensation type
  - Allowed values: `Salary`, `Hourly`
- `compensation_type_effective_date` (date, required) — Date the employee's current compensation type took effect
- `deductions` (list of DeductionDetail, required) — Payroll deductions from the most recent statement period. Replaced when a new statement is generated.
- `created_at` (datetime, required) — Timestamp when the employee was created
- `updated_at` (datetime, required) — Timestamp when the employee was last updated
- `reference_id` (string, optional, nullable) — Partner-assigned reference ID for the employee
- `employer_name` (string, optional, nullable) — Name of the employer this employment is with
- `suffix` (string, optional, nullable) — Name suffix (e.g., Jr., Sr., III)
- `gender` (string, optional, nullable) — Gender identity, if provided
- `termination_date` (date, optional, nullable) — Employee's termination date, if terminated
- `address` (EmployeeAddress, optional, nullable) — Employee's residential address

### DeductionDetail

- `deduction_category` (string, required, nullable) — Deduction category (reserved for future use)
- `deduction_amount_in_cents` (integer, required) — Employee deduction amount in cents
- `tax_classification` (enum, required) — Tax classification: Pre-tax, Post-tax, or Unknown * `Unknown` - Unknown * `Pre-tax` - Pre Tax * `Post-tax` - Post Tax
  - Allowed values: `Unknown`, `Pre-tax`, `Post-tax`
- `frequency` (enum, required) — Deduction frequency * `weekly` - Weekly * `bi_weekly` - Bi Weekly * `semi_monthly` - Semi Monthly * `monthly` - Monthly
  - Allowed values: `weekly`, `bi_weekly`, `semi_monthly`, `monthly`
- `benefit_name` (string, required) — Name of the benefit plan
- `period_start_date` (date, required) — Period start date (YYYY-MM-DD)
- `period_end_date` (date, required) — Period end date (YYYY-MM-DD)

### EmployeeAddress

- `address_line_1` (string, required) — Primary street address
- `city` (string, required) — City name
- `state` (string, required) — Two-letter state code (e.g., CA, NY)
- `zipcode` (string, required) — ZIP code (5 or 9 digit)
- `address_line_2` (string, optional, nullable) — Secondary street address (apt, suite, etc.)

## Examples

**Request**

```json
{
  "effective_date": "2023-03-01",
  "employee_class": "Full Time",
  "start_date": "2023-01-15",
  "compensation_type": "Salary"
}
```

**Response**

```json
{
  "data": {
    "id": "string",
    "member_id": "string",
    "employer_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "date_of_birth": "2023-01-15",
    "phone": "string",
    "employee_class": "Full Time",
    "status": "active",
    "start_date": "2023-01-15",
    "classification_effective_date": "2023-01-15",
    "compensation_type": "Salary",
    "compensation_type_effective_date": "2023-01-15",
    "deductions": [
      {
        "deduction_category": "string",
        "deduction_amount_in_cents": 1,
        "tax_classification": "Unknown",
        "frequency": "weekly",
        "benefit_name": "string",
        "period_start_date": "2023-01-15",
        "period_end_date": "2023-01-15"
      }
    ],
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "reference_id": "string",
    "employer_name": "string",
    "suffix": "string",
    "gender": "string",
    "termination_date": "2023-01-15",
    "address": {
      "address_line_1": "string",
      "city": "string",
      "state": "string",
      "zipcode": "string",
      "address_line_2": "string"
    }
  }
}
```

**SDK Code**

```python Update Employee Employment
import requests

url = "https://api.vitablehealth.com/v1/employees/empl_abc123def456"

payload = {
    "effective_date": "2023-03-01",
    "employee_class": "Full Time",
    "start_date": "2023-01-15",
    "compensation_type": "Salary"
}
headers = {
    "Authorization": "Bearer <apiKey>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Update Employee Employment
const url = 'https://api.vitablehealth.com/v1/employees/empl_abc123def456';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <apiKey>', 'Content-Type': 'application/json'},
  body: '{"effective_date":"2023-03-01","employee_class":"Full Time","start_date":"2023-01-15","compensation_type":"Salary"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Update Employee Employment
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vitablehealth.com/v1/employees/empl_abc123def456"

	payload := strings.NewReader("{\n  \"effective_date\": \"2023-03-01\",\n  \"employee_class\": \"Full Time\",\n  \"start_date\": \"2023-01-15\",\n  \"compensation_type\": \"Salary\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Update Employee Employment
require 'uri'
require 'net/http'

url = URI("https://api.vitablehealth.com/v1/employees/empl_abc123def456")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"effective_date\": \"2023-03-01\",\n  \"employee_class\": \"Full Time\",\n  \"start_date\": \"2023-01-15\",\n  \"compensation_type\": \"Salary\"\n}"

response = http.request(request)
puts response.read_body
```

```java Update Employee Employment
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.vitablehealth.com/v1/employees/empl_abc123def456")
  .header("Authorization", "Bearer <apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"effective_date\": \"2023-03-01\",\n  \"employee_class\": \"Full Time\",\n  \"start_date\": \"2023-01-15\",\n  \"compensation_type\": \"Salary\"\n}")
  .asString();
```

```php Update Employee Employment
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.vitablehealth.com/v1/employees/empl_abc123def456', [
  'body' => '{
  "effective_date": "2023-03-01",
  "employee_class": "Full Time",
  "start_date": "2023-01-15",
  "compensation_type": "Salary"
}',
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Update Employee Employment
using RestSharp;

var client = new RestClient("https://api.vitablehealth.com/v1/employees/empl_abc123def456");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"effective_date\": \"2023-03-01\",\n  \"employee_class\": \"Full Time\",\n  \"start_date\": \"2023-01-15\",\n  \"compensation_type\": \"Salary\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Update Employee Employment
import Foundation

let headers = [
  "Authorization": "Bearer <apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "effective_date": "2023-03-01",
  "employee_class": "Full Time",
  "start_date": "2023-01-15",
  "compensation_type": "Salary"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.vitablehealth.com/v1/employees/empl_abc123def456")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```