Update an employee

patch

https://api.talent.performyard.com/v1/employees/{id}

Modifies the profile information for a single employee.

Path Params

required

Body Params

_id

string

first_name

string

The employee's legal first name.

last_name

string

The employee's legal last name.

nickname

string

The employee's preferred or commonly used name. When an employee has nickname set, the name property on GET requests will follow the format "nickname last_name".

string

The employee's company or official email address. Must be a valid email format.

phone

string

The employee's primary phone number. Dashes are optional.

job_title

string

The employee's official job title or role within the company.

hire_date

The date in which the employee was officially hired. Allowed Formats: YYYY-MM-DD, MM-DD-YYYY.

termination_date

The date in which the employee's employment ended. Allowed Formats: YYYY-MM-DD, MM-DD-YYYY.

group

string

The name of the group in which the employee belongs to. The group must exist in PerformYard.

employee_status

string

enum

The current employment status of the employee.

Allowed:

manager

string

The email address of the employee's direct manager.

contributors

array of strings

The email address(es) of contributors to the employee.

contributors

salary

custom_fields

array of objects

Used to update the employee data fields created by the company. Accepts an array of objects where each object includes field_name and field_value, both of which accept a single string value.

custom_fields

Responses

200Default Response

400Default Response

404Default Response

500Default Response