PATCH
/
unified
/
hris
/
employees
/
{id}
curl --request PATCH \
  --url https://api.stackone.com/unified/hris/employees/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '{
  "first_name": "Issac",
  "last_name": "Newton",
  "name": "Issac Newton",
  "display_name": "Sir Issac Newton",
  "avatar_url": "https://example.com/avatar.png",
  "personal_email": "isaac.newton@example.com",
  "personal_phone_number": "+1234567890",
  "work_email": "newton@example.com",
  "work_phone_number": "+1234567890",
  "job_id": "R-6789",
  "job_title": "Physicist",
  "department_id": "3093",
  "department": "Physics",
  "manager_id": "67890",
  "gender": "male",
  "preferred_language": "en_US",
  "ethnicity": "white",
  "date_of_birth": "1990-01-01T00:00.000Z",
  "birthday": "2021-01-01T00:00:00Z",
  "marital_status": "single",
  "avatar": "https://example.com/avatar.png",
  "hire_date": "2021-01-01T00:00.000Z",
  "start_date": "2021-01-01T00:00.000Z",
  "tenure": 2,
  "work_anniversary": "2021-01-01T00:00:00Z",
  "employment_type": "full_time",
  "employment_contract_type": "full_time",
  "employment_status": "active",
  "termination_date": "2021-01-01T00:00:00Z",
  "company_name": "Example Corp",
  "company_id": "1234567890",
  "citizenships": [
    {
      "value": "US",
      "source_value": "<string>"
    }
  ],
  "custom_fields": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Training Completion Status",
      "value": "Completed",
      "value_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "benefits": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Health Insurance",
      "benefit_type": {
        "value": "retirement_savings",
        "source_value": "<string>"
      },
      "provider": "Aetna",
      "description": "Health insurance for employees",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ],
  "employee_number": "125",
  "national_identity_number": {
    "value": "123456789",
    "type": {
      "value": "ssn",
      "source_value": "<string>"
    },
    "country": {
      "value": "US",
      "source_value": "<string>"
    }
  },
  "national_identity_numbers": [
    {
      "value": "123456789",
      "type": {
        "value": "ssn",
        "source_value": "<string>"
      },
      "country": {
        "value": "US",
        "source_value": "<string>"
      }
    }
  ],
  "home_location": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "Woolsthorpe Manor",
    "phone_number": "+44 1476 860 364",
    "street_1": "Water Lane",
    "street_2": "Woolsthorpe by Colsterworth",
    "city": "Grantham",
    "zip_code": "NG33 5NR",
    "country": {
      "value": "US",
      "source_value": "<string>"
    },
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "state": "GB-LIN"
  },
  "work_location": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "Woolsthorpe Manor",
    "phone_number": "+44 1476 860 364",
    "street_1": "Water Lane",
    "street_2": "Woolsthorpe by Colsterworth",
    "city": "Grantham",
    "zip_code": "NG33 5NR",
    "country": {
      "value": "US",
      "source_value": "<string>"
    },
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "state": "GB-LIN"
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}'
{
  "first_name": "Issac",
  "last_name": "Newton",
  "name": "Issac Newton",
  "display_name": "Sir Issac Newton",
  "avatar_url": "https://example.com/avatar.png",
  "personal_email": "isaac.newton@example.com",
  "personal_phone_number": "+1234567890",
  "work_email": "newton@example.com",
  "work_phone_number": "+1234567890",
  "job_id": "R-6789",
  "job_title": "Physicist",
  "department_id": "3093",
  "department": "Physics",
  "manager_id": "67890",
  "gender": "male",
  "preferred_language": "en_US",
  "ethnicity": "white",
  "date_of_birth": "1990-01-01T00:00.000Z",
  "birthday": "2021-01-01T00:00:00Z",
  "marital_status": "single",
  "avatar": "https://example.com/avatar.png",
  "hire_date": "2021-01-01T00:00.000Z",
  "start_date": "2021-01-01T00:00.000Z",
  "tenure": 2,
  "work_anniversary": "2021-01-01T00:00:00Z",
  "employment_type": "full_time",
  "employment_contract_type": "full_time",
  "employment_status": "active",
  "termination_date": "2021-01-01T00:00:00Z",
  "company_name": "Example Corp",
  "company_id": "1234567890",
  "citizenships": [
    {
      "value": "US",
      "source_value": "<string>"
    }
  ],
  "custom_fields": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Training Completion Status",
      "value": "Completed",
      "value_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "benefits": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Health Insurance",
      "benefit_type": {
        "value": "retirement_savings",
        "source_value": "<string>"
      },
      "provider": "Aetna",
      "description": "Health insurance for employees",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ],
  "employee_number": "125",
  "national_identity_number": {
    "value": "123456789",
    "type": {
      "value": "ssn",
      "source_value": "<string>"
    },
    "country": {
      "value": "US",
      "source_value": "<string>"
    }
  },
  "national_identity_numbers": [
    {
      "value": "123456789",
      "type": {
        "value": "ssn",
        "source_value": "<string>"
      },
      "country": {
        "value": "US",
        "source_value": "<string>"
      }
    }
  ],
  "home_location": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "Woolsthorpe Manor",
    "phone_number": "+44 1476 860 364",
    "street_1": "Water Lane",
    "street_2": "Woolsthorpe by Colsterworth",
    "city": "Grantham",
    "zip_code": "NG33 5NR",
    "country": {
      "value": "US",
      "source_value": "<string>"
    },
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "state": "GB-LIN"
  },
  "work_location": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "Woolsthorpe Manor",
    "phone_number": "+44 1476 860 364",
    "street_1": "Water Lane",
    "street_2": "Woolsthorpe by Colsterworth",
    "city": "Grantham",
    "zip_code": "NG33 5NR",
    "country": {
      "value": "US",
      "source_value": "<string>"
    },
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "state": "GB-LIN"
  }
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Path Parameters

id
string
required

Body

application/json
first_name
string | null

The employee first name

Example:

"Issac"

last_name
string | null

The employee last name

Example:

"Newton"

name
string | null

The employee name

Example:

"Issac Newton"

display_name
string | null

The employee display name

Example:

"Sir Issac Newton"

avatar_url
string | null

The employee avatar Url

Example:

"https://example.com/avatar.png"

personal_email
string | null

The employee personal email

Example:

"isaac.newton@example.com"

personal_phone_number
string | null

The employee personal phone number

Example:

"+1234567890"

work_email
string | null

The employee work email

Example:

"newton@example.com"

work_phone_number
string | null

The employee work phone number

Example:

"+1234567890"

job_id
string | null

The employee job id

Example:

"R-6789"

job_title
string | null

The employee job title

Example:

"Physicist"

department_id
string | null

The employee department id

Example:

"3093"

department
string | null

The employee department

Example:

"Physics"

manager_id
string | null

The employee manager ID

Example:

"67890"

gender
object

The employee gender

Example:

"male"

preferred_language
object

The employee preferred language

Example:

"en_US"

ethnicity
object

The employee ethnicity

Example:

"white"

date_of_birth
string | null

The employee date_of_birth

Example:

"1990-01-01T00:00.000Z"

birthday
string | null

The employee birthday

Example:

"2021-01-01T00:00:00Z"

marital_status
object

The employee marital status

Example:

"single"

avatar
object

The employee avatar

Example:

"https://example.com/avatar.png"

hire_date
string | null

The employee hire date

Example:

"2021-01-01T00:00.000Z"

start_date
string | null

The employee start date

Example:

"2021-01-01T00:00.000Z"

tenure
number | null

The employee tenure

Example:

2

work_anniversary
string | null

The employee work anniversary

Example:

"2021-01-01T00:00:00Z"

employment_type
object

The employee employment type

Example:

"full_time"

employment_contract_type
object

The employment work schedule type (e.g., full-time, part-time)

Example:

"full_time"

employment_status
object

The employee employment status

Example:

"active"

termination_date
string | null

The employee termination date

Example:

"2021-01-01T00:00:00Z"

company_name
string | null
deprecated

The employee company name

Example:

"Example Corp"

company_id
string | null

The employee company id

Example:

"1234567890"

citizenships
object[] | null

The citizenships of the Employee

custom_fields
object[] | null

The employee custom fields

benefits
object[] | null

Current benefits of the employee

employee_number
string | null

The assigned employee number

Example:

"125"

national_identity_number
object
deprecated

The national identity number

national_identity_numbers
object[] | null

The national identity numbers

home_location
object

The employee home location

work_location
object

The employee work location

passthrough
object | null

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response

200
application/json
Record updated successfully
first_name
string | null

The employee first name

Example:

"Issac"

last_name
string | null

The employee last name

Example:

"Newton"

name
string | null

The employee name

Example:

"Issac Newton"

display_name
string | null

The employee display name

Example:

"Sir Issac Newton"

avatar_url
string | null

The employee avatar Url

Example:

"https://example.com/avatar.png"

personal_email
string | null

The employee personal email

Example:

"isaac.newton@example.com"

personal_phone_number
string | null

The employee personal phone number

Example:

"+1234567890"

work_email
string | null

The employee work email

Example:

"newton@example.com"

work_phone_number
string | null

The employee work phone number

Example:

"+1234567890"

job_id
string | null

The employee job id

Example:

"R-6789"

job_title
string | null

The employee job title

Example:

"Physicist"

department_id
string | null

The employee department id

Example:

"3093"

department
string | null

The employee department

Example:

"Physics"

manager_id
string | null

The employee manager ID

Example:

"67890"

gender
object

The employee gender

Example:

"male"

preferred_language
object

The employee preferred language

Example:

"en_US"

ethnicity
object

The employee ethnicity

Example:

"white"

date_of_birth
string | null

The employee date_of_birth

Example:

"1990-01-01T00:00.000Z"

birthday
string | null

The employee birthday

Example:

"2021-01-01T00:00:00Z"

marital_status
object

The employee marital status

Example:

"single"

avatar
object

The employee avatar

Example:

"https://example.com/avatar.png"

hire_date
string | null

The employee hire date

Example:

"2021-01-01T00:00.000Z"

start_date
string | null

The employee start date

Example:

"2021-01-01T00:00.000Z"

tenure
number | null

The employee tenure

Example:

2

work_anniversary
string | null

The employee work anniversary

Example:

"2021-01-01T00:00:00Z"

employment_type
object

The employee employment type

Example:

"full_time"

employment_contract_type
object

The employment work schedule type (e.g., full-time, part-time)

Example:

"full_time"

employment_status
object

The employee employment status

Example:

"active"

termination_date
string | null

The employee termination date

Example:

"2021-01-01T00:00:00Z"

company_name
string | null
deprecated

The employee company name

Example:

"Example Corp"

company_id
string | null

The employee company id

Example:

"1234567890"

citizenships
object[] | null

The citizenships of the Employee

custom_fields
object[] | null

The employee custom fields

benefits
object[] | null

Current benefits of the employee

employee_number
string | null

The assigned employee number

Example:

"125"

national_identity_number
object
deprecated

The national identity number

national_identity_numbers
object[] | null

The national identity numbers

home_location
object

The employee home location

work_location
object

The employee work location