---
title: "Update an employee"
method: PATCH
path: "/hris/{connection_id}/employee/{id}"
tags: ["hris", "employee"]
---

# Update an employee

`PATCH /hris/{connection_id}/employee/{id}`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/hris/{connection_id}/employee/{id}`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required
- `id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- HrisEmployee
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `name` string
  - `first_name` string
  - `last_name` string
  - `emails` HrisEmail[]
    - `email` string, required
    - `type` 'WORK' | 'HOME' | 'OTHER'
  - `title` string
  - `job_id` string: the hris_job (position) this employee holds; their primary job when they hold more than one
  - `manager_id` string
  - `employment_status` 'ACTIVE' | 'INACTIVE'
  - `gender` 'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
  - `telephones` HrisTelephone[]
    - `telephone` string, required
    - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
  - `date_of_birth` string, date-time: YYYYMM/DD
  - `employee_number` string: the company's ID for this employee
  - `hired_at` string, date-time: The employee's start date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `terminated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `termination_reason` string
  - `marital_status` 'MARRIED' | 'SINGLE'
  - `employment_type` 'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER'
  - `address` HrisEmployeeAddress
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string: ISO 2-digit country code
  - `language_locale` string
  - `currency` string
  - `timezone` string
  - `image_url` string: This link expires after 1 hour.
  - `company_id` string: (reference to HrisCompany)
  - `pronouns` string
  - `employee_roles` string[]
  - `compensation` HrisCompensation[]
    - `type` 'SALARY' | 'BONUS' | 'STOCK_OPTIONS' | 'EQUITY' | 'OTHER' | 'HOURLY' | 'COMMISSION'
    - `amount` number
    - `currency` string
    - `frequency` 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'
    - `group_id` string: (reference to HrisGroup)
    - `notes` string
  - `salutation` string: Mr. Mrs. Ms.
  - `bio` string
  - `ssn_sin` string
  - `groups` HrisGroup[]: Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email.
    - `id` string
    - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `name` string
    - `description` string
    - `parent_id` string
    - `type` 'TEAM' | 'GROUP' | 'DEPARTMENT' | 'DIVISION' | 'BUSINESS_UNIT' | 'BRANCH' | 'SUB_DEPARTMENT' | 'PAY_GROUP'
    - `user_ids` string[]
    - `manager_ids` string[]
    - `is_active` boolean
    - `company_id` string: (reference to HrisCompany)
    - `pay_frequency` 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY': pay cycle when type is PAY_GROUP
    - `next_paid_at` string, date-time: next pay date when type is PAY_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `metadata` HrisMetadata[]
      - `id` string
      - `value` unknown
      - `namespace` string
      - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
      - `extra_data` unknown
      - `slug` string
    - `raw` unknown
  - `locations` HrisLocation[]
    - `id` string
    - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `name` string
    - `description` string
    - `address` HrisLocationAddress
      - `address1` string
      - `address2` string
      - `city` string
      - `region` string
      - `region_code` string
      - `postal_code` string
      - `country` string
      - `country_code` string: ISO 2-digit country code
    - `parent_id` string
    - `external_identifier` string
    - `telephones` HrisTelephone[]
      - `telephone` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
    - `timezone` string
    - `currency` string
    - `language_locale` string
    - `is_active` boolean
    - `is_hq` boolean: if this location is the headquarters of the company
    - `company_id` string: (reference to HrisCompany)
    - `metadata` HrisMetadata[]
      - `id` string
      - `value` unknown
      - `namespace` string
      - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
      - `extra_data` unknown
      - `slug` string
    - `raw` unknown
  - `metadata` HrisMetadata[]
    - `id` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
    - `slug` string
  - `storage_quota_allocated` number
  - `storage_quota_used` number
  - `storage_quota_available` number
  - `relationships` HrisEmployeerelationship[]: the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...)
    - `name` string
    - `first_name` string
    - `last_name` string
    - `emails` HrisEmail[]
      - `email` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER'
    - `telephones` HrisTelephone[]
      - `telephone` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
    - `address` HrisEmployeerelationshipAddress
      - `address1` string
      - `address2` string
      - `city` string
      - `region` string
      - `region_code` string
      - `postal_code` string
      - `country` string
      - `country_code` string: ISO 2-digit country code
    - `type` 'EMERGENCY' | 'SPOUSE' | 'CHILD' | 'PARENT' | 'SIBLING' | 'FRIEND' | 'OTHER'
    - `is_dependent` boolean
    - `is_beneficiary` boolean
    - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `has_mfa` boolean: does the user/employee have multi-factor authentication enabled
  - `timeoff_days_total` number: Total time off allowance for the current leave period, in days (when reported by the provider)
  - `timeoff_days_used` number: Time off days used or booked in the current leave period (when reported by the provider)
  - `flsa_status` 'EXEMPT' | 'NON_EXEMPT' | 'SALARIED_NONEXEMPT' | 'OWNER': US Fair Labor Standards Act classification
  - `pay_frequency` 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY': how often the employee is paid (eg. BIWEEKLY)
  - `raw` unknown

## Response `200`

Successful

- HrisEmployee
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `name` string
  - `first_name` string
  - `last_name` string
  - `emails` HrisEmail[]
    - `email` string, required
    - `type` 'WORK' | 'HOME' | 'OTHER'
  - `title` string
  - `job_id` string: the hris_job (position) this employee holds; their primary job when they hold more than one
  - `manager_id` string
  - `employment_status` 'ACTIVE' | 'INACTIVE'
  - `gender` 'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
  - `telephones` HrisTelephone[]
    - `telephone` string, required
    - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
  - `date_of_birth` string, date-time: YYYYMM/DD
  - `employee_number` string: the company's ID for this employee
  - `hired_at` string, date-time: The employee's start date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `terminated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `termination_reason` string
  - `marital_status` 'MARRIED' | 'SINGLE'
  - `employment_type` 'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER'
  - `address` HrisEmployeeAddress
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string: ISO 2-digit country code
  - `language_locale` string
  - `currency` string
  - `timezone` string
  - `image_url` string: This link expires after 1 hour.
  - `company_id` string: (reference to HrisCompany)
  - `pronouns` string
  - `employee_roles` string[]
  - `compensation` HrisCompensation[]
    - `type` 'SALARY' | 'BONUS' | 'STOCK_OPTIONS' | 'EQUITY' | 'OTHER' | 'HOURLY' | 'COMMISSION'
    - `amount` number
    - `currency` string
    - `frequency` 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'
    - `group_id` string: (reference to HrisGroup)
    - `notes` string
  - `salutation` string: Mr. Mrs. Ms.
  - `bio` string
  - `ssn_sin` string
  - `groups` HrisGroup[]: Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email.
    - `id` string
    - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `name` string
    - `description` string
    - `parent_id` string
    - `type` 'TEAM' | 'GROUP' | 'DEPARTMENT' | 'DIVISION' | 'BUSINESS_UNIT' | 'BRANCH' | 'SUB_DEPARTMENT' | 'PAY_GROUP'
    - `user_ids` string[]
    - `manager_ids` string[]
    - `is_active` boolean
    - `company_id` string: (reference to HrisCompany)
    - `pay_frequency` 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY': pay cycle when type is PAY_GROUP
    - `next_paid_at` string, date-time: next pay date when type is PAY_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `metadata` HrisMetadata[]
      - `id` string
      - `value` unknown
      - `namespace` string
      - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
      - `extra_data` unknown
      - `slug` string
    - `raw` unknown
  - `locations` HrisLocation[]
    - `id` string
    - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `name` string
    - `description` string
    - `address` HrisLocationAddress
      - `address1` string
      - `address2` string
      - `city` string
      - `region` string
      - `region_code` string
      - `postal_code` string
      - `country` string
      - `country_code` string: ISO 2-digit country code
    - `parent_id` string
    - `external_identifier` string
    - `telephones` HrisTelephone[]
      - `telephone` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
    - `timezone` string
    - `currency` string
    - `language_locale` string
    - `is_active` boolean
    - `is_hq` boolean: if this location is the headquarters of the company
    - `company_id` string: (reference to HrisCompany)
    - `metadata` HrisMetadata[]
      - `id` string
      - `value` unknown
      - `namespace` string
      - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
      - `extra_data` unknown
      - `slug` string
    - `raw` unknown
  - `metadata` HrisMetadata[]
    - `id` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
    - `slug` string
  - `storage_quota_allocated` number
  - `storage_quota_used` number
  - `storage_quota_available` number
  - `relationships` HrisEmployeerelationship[]: the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...)
    - `name` string
    - `first_name` string
    - `last_name` string
    - `emails` HrisEmail[]
      - `email` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER'
    - `telephones` HrisTelephone[]
      - `telephone` string, required
      - `type` 'WORK' | 'HOME' | 'OTHER' | 'FAX' | 'MOBILE'
    - `address` HrisEmployeerelationshipAddress
      - `address1` string
      - `address2` string
      - `city` string
      - `region` string
      - `region_code` string
      - `postal_code` string
      - `country` string
      - `country_code` string: ISO 2-digit country code
    - `type` 'EMERGENCY' | 'SPOUSE' | 'CHILD' | 'PARENT' | 'SIBLING' | 'FRIEND' | 'OTHER'
    - `is_dependent` boolean
    - `is_beneficiary` boolean
    - `start_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    - `end_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `has_mfa` boolean: does the user/employee have multi-factor authentication enabled
  - `timeoff_days_total` number: Total time off allowance for the current leave period, in days (when reported by the provider)
  - `timeoff_days_used` number: Time off days used or booked in the current leave period (when reported by the provider)
  - `flsa_status` 'EXEMPT' | 'NON_EXEMPT' | 'SALARIED_NONEXEMPT' | 'OWNER': US Fair Labor Standards Act classification
  - `pay_frequency` 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY': how often the employee is paid (eg. BIWEEKLY)
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)