Skip to main content
PUT
/
v1
/
company-members
/
{company_member_id}
Update employee information
curl --request PUT \
  --url https://api.vitablehealth.com/v1/company-members/{company_member_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Partner-API-Key: <api-key>' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "[email protected]",
  "employee_id": "<string>",
  "hire_date": "2023-12-25",
  "employment_status": "Active",
  "employee_class": "Full Time"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_active_in": true,
    "created": "2023-11-07T05:31:56Z",
    "benefit_eligibility_start_date": "2023-11-07T05:31:56Z",
    "enrolled_in_benefits_in": true,
    "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "address": {
      "street_address": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip_code": "<string>"
    },
    "address_str_format": "<string>",
    "first_name": "<string>",
    "full_name": "<string>",
    "date_of_birth": "2023-12-25",
    "email": "<string>",
    "age": 123,
    "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "company_name": "<string>",
    "hris_id": "<string>",
    "type": "Employee",
    "active_in": true,
    "employee_class": "Full Time",
    "employee_start_date": "2023-12-25",
    "employee_compensation_type": "Salary",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "middle_name": "<string>",
    "last_name": "<string>",
    "suffix": "Sr",
    "sex": "Male",
    "gender": "Male",
    "phone_number": "<string>",
    "phone": "<string>",
    "profile_picture_url": "<string>",
    "preferred_language": "en",
    "public_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "individual_income_in_cents": 123,
    "household_income_in_cents": 123,
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "tag_color": "<string>",
        "description": "<string>"
      }
    ]
  }
}

Authorizations

​
X-Partner-API-Key
string
header
required

Partner API key for external integrations

Path Parameters

​
company_member_id
string<uuid>
required

Unique identifier for the company member

Body

application/json
​
first_name
string

Employee first name

​
last_name
string

Employee last name

​
email
string<email>

Employee email address

​
employee_id
string

External employee ID from HRIS

​
hire_date
string<date>

Employee hire date

​
employment_status
enum<string>

Current employment status

Available options:
Active,
Terminated,
Leave of Absence
​
employee_class
enum<string>

Employment classification

Available options:
Full Time,
Part Time,
Temporary,
Intern,
Seasonal,
Individual Contractor

Response

200 - application/json

Updated company member details

​
data
object