Update Employee

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 '{
  "title": "Mr",
  "first_name": "Isaac",
  "last_name": "Newton",
  "name": "Isaac Newton",
  "display_name": "Sir Isaac 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",
  "team_id": "2913",
  "department": "Physics",
  "manager_id": "67890",
  "gender": "male",
  "preferred_language": "eng",
  "ethnicity": "white",
  "date_of_birth": "1990-01-01T00:00:00.000Z",
  "birthday": "2021-01-01T00:00:00Z",
  "marital_status": "single",
  "avatar": "https://example.com/avatar.png",
  "hire_date": "2021-01-01T00:00:00.000Z",
  "start_date": "2021-01-01T00:00:00.000Z",
  "employment_type": "permanent",
  "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>"
    }
  ],
  "employment": {
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "job_title": "Software Engineer",
    "pay_rate": "40.00",
    "pay_period": "monthly",
    "pay_frequency": "hourly",
    "pay_currency": "USD",
    "end_date": "2021-01-01T01:01:01.000Z",
    "grade": {
      "id": "1687-3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "1687-4",
      "description": "Mid-level employee demonstrating proficiency and autonomy."
    },
    "employment_type": "permanent",
    "employment_contract_type": "full_time",
    "type": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "label": "Permanent",
      "type": "permanent"
    },
    "contract_type": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "label": "Full-Time",
      "contract_type": "full_time"
    },
    "work_time": {
      "duration": "P0Y0M0DT8H0M0S",
      "period": "month"
    },
    "payroll_code": "PC1",
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "effective_date": "2021-01-01T00:00:00.000Z"
  },
  "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"
  }
}'

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}

PATCH

unified

hris

employees

{id}

Update Employee

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 '{
  "title": "Mr",
  "first_name": "Isaac",
  "last_name": "Newton",
  "name": "Isaac Newton",
  "display_name": "Sir Isaac 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",
  "team_id": "2913",
  "department": "Physics",
  "manager_id": "67890",
  "gender": "male",
  "preferred_language": "eng",
  "ethnicity": "white",
  "date_of_birth": "1990-01-01T00:00:00.000Z",
  "birthday": "2021-01-01T00:00:00Z",
  "marital_status": "single",
  "avatar": "https://example.com/avatar.png",
  "hire_date": "2021-01-01T00:00:00.000Z",
  "start_date": "2021-01-01T00:00:00.000Z",
  "employment_type": "permanent",
  "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>"
    }
  ],
  "employment": {
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "job_title": "Software Engineer",
    "pay_rate": "40.00",
    "pay_period": "monthly",
    "pay_frequency": "hourly",
    "pay_currency": "USD",
    "end_date": "2021-01-01T01:01:01.000Z",
    "grade": {
      "id": "1687-3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "1687-4",
      "description": "Mid-level employee demonstrating proficiency and autonomy."
    },
    "employment_type": "permanent",
    "employment_contract_type": "full_time",
    "type": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "label": "Permanent",
      "type": "permanent"
    },
    "contract_type": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "label": "Full-Time",
      "contract_type": "full_time"
    },
    "work_time": {
      "duration": "P0Y0M0DT8H0M0S",
      "period": "month"
    },
    "payroll_code": "PC1",
    "passthrough": {
      "other_known_names": "John Doe"
    },
    "effective_date": "2021-01-01T00:00:00.000Z"
  },
  "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"
  }
}'

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}

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

string

required

Body

application/json

title

string | null

The prefix of the employee's name (e.g., Mr, Ms, Dr)

Example:

"Mr"

first_name

string | null

The employee first name

Example:

"Isaac"

last_name

string | null

The employee last name

Example:

"Newton"

name

string | null

The employee name

Example:

"Isaac Newton"

display_name

string | null

The employee display name

Example:

"Sir Isaac 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

deprecated

The employee job id

Example:

"R-6789"

job_title

string | null

If the source of the job_title is the Employee's current Employment, and that Employment pertains exclusively to this Employee, then the active Employment job_title will also be written

Example:

"Physicist"

department_id

string | null

The employee department id

Example:

"3093"

team_id

string | null

The employee team id

Example:

"2913"

department

string | null

The employee department

Example:

"Physics"

manager_id

string | null

The employee manager ID

Example:

"67890"

gender

object

The employee gender

Show child attributes

Example:

"male"

preferred_language

object

The employee preferred language

Show child attributes

Example:

"eng"

ethnicity

object

The employee ethnicity

Show child attributes

Example:

"white"

date_of_birth

string<date-time> | null

The date when the employee was born

Example:

"1990-01-01T00:00:00.000Z"

birthday

string<date-time> | null

The next birthday of the employee (upcoming birthday)

Example:

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

marital_status

object

The employee marital status

Show child attributes

Example:

"single"

avatar

object

The employee avatar

Show child attributes

Example:

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

hire_date

string<date-time> | null

The employee hire date

Example:

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

start_date

string<date-time> | null

The employee start date

Example:

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

employment_type

object

deprecated

The employee employment type

Show child attributes

Example:

"permanent"

employment_contract_type

object

deprecated

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

Show child attributes

Example:

"full_time"

employment_status

object

The employee employment status

Show child attributes

Example:

"active"

termination_date

string<date-time> | 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

Show child attributes

employment

object

The employee employment

Show child attributes

custom_fields

object[] | null

The employee custom fields

Show child attributes

benefits

object[] | null

Current benefits of the employee

Show child attributes

employee_number

string | null

The assigned employee number

Example:

"125"

national_identity_number

object

deprecated

The national identity number

Show child attributes

national_identity_numbers

object[] | null

The national identity numbers

Show child attributes

home_location

object

The employee home location

Show child attributes

work_location

object

The employee work location

Show child attributes

passthrough

object | null

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

Response

Record updated successfully

statusCode

number

required

Example:

200

message

string

required

Example:

"Record updated successfully."

timestamp

string<date-time>

required

Example:

"2021-01-01T01:01:01.000Z"

Get Employee Invite Employee

⌘I

Getting Started

Use Cases

API Reference

Update Employee

Authorizations

Headers

Path Parameters

Body

Response