Sign in

v1

latestOpenAPI 3.1.02026-07-1274177461.2 KB
Employees

Update Employee

patch/unified/hris/employees/{id}

Path parameters

idstring required

Headers

x-account-idstring required

The account identifier

Preferstring
Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

titlestring nullable

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

first_namestring nullable

The employee first name

last_namestring nullable

The employee last name

namestring nullable

The employee name

display_namestring nullable

The employee display name

avatar_urlstring nullable

The employee avatar Url

personal_emailstring nullable

The employee personal email

personal_phone_numberstring nullable

The employee personal phone number

work_emailstring nullable

The employee work email

work_phone_numberstring nullable

The employee work phone number

job_idstring nullable

The employee job id

job_titlestring nullable

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

department_idstring nullable

The employee department id

team_idstring nullable

The employee team id

departmentstring nullable

The employee department

manager_idstring nullable

The employee manager ID

date_of_birthstring date-time nullable

The date when the employee was born

birthdaystring date-time nullable

The next birthday of the employee (upcoming birthday)

hire_datestring date-time nullable

The employee hire date

start_datestring date-time nullable

The employee start date

termination_datestring date-time nullable

The employee termination date

company_namestring nullable

The employee company name

company_idstring nullable

The employee company id

employee_numberstring nullable

The assigned employee number

passthroughobject nullable

Value to pass through to the provider

Example request

{
  "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",
  "preferred_language": {
    "value": "eng"
  },
  "date_of_birth": "1990-01-01T00:00:00.000Z",
  "birthday": "2021-01-01T00:00:00Z",
  "hire_date": "2021-01-01T00:00:00.000Z",
  "start_date": "2021-01-01T00:00:00.000Z",
  "termination_date": "2021-01-01T00:00:00Z",
  "company_name": "Example Corp",
  "company_id": "1234567890",
  "citizenships": [
    {
      "value": "US"
    }
  ],
  "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_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."
    },
    "type": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "label": "Permanent"
    },
    "contract_type": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "label": "Full-Time"
    },
    "work_time": {
      "duration": "P0Y0M0DT8H0M0S",
      "period": {
        "value": "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_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "benefits": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Health Insurance",
      "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"
    },
    "country": {
      "value": "US"
    }
  },
  "national_identity_numbers": [
    {
      "value": "123456789",
      "type": {
        "value": "ssn"
      },
      "country": {
        "value": "US"
      }
    }
  ],
  "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"
    },
    "passthrough": {
      "other_known_names": "John Doe"
    }
  },
  "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"
    },
    "passthrough": {
      "other_known_names": "John Doe"
    }
  },
  "passthrough": {
    "other_known_names": "John Doe"
  }
}

Response

Record updated successfully

statusCodenumber required
messagestring required
timestampstring date-time required

Example response

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