PUT Employee

put

https://www.humanity.com/api/v2/employees/{id}

/employees/:id Permission level: 5

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Form Data

job_title

string

notes

string

eid

string

unique_id

string

A custom identifier that serves as an alternative ID for retrieving a specific employee with GET employee by Unique ID endpoint.

first_name

string

group

string

enum [2, 3, 4, 5, 6, 7] -> 2: Manager; 3: Supervisor; 4: Scheduler; 5: Employee; 6: Accountant; 7: Schedule Viewer

status

string

enum [0, 1, -1, -2] -> -1: Disabled; 0: Deactivated; 1: Activated

name

string

last_name

string

nick_name

string

wage

int32

cell_phone

string

birth_day

int32

birth_month

int32

p_email

int32

enum [0, 1]

p_phone

int32

enum [0, 1]

state

string

address

string

home_phone

string

city

string

zip

string

gender

string

enum['M','F']

middle_name

string

max_days_row

int32

custom

string

A JSON string representing an object with multiple key-value pairs.
The key should contain a Custom Field ID, and the value a Custom Field content.

language

string

removeschedule

string

Unassigns position(s) from a staff member.
String of Position (Schedule) IDs, separated with comma.
Example: 138641,138642,143893

smsgateway

int32

password

string

Minimum 6 characters.

addskill

int32

Skill ID

addschedule

string

Assigns position(s) to a staff member.
String of Position (Schedule) IDs, separated with comma.
Example: 138641,138642,143893

username

string

Minimum 3 characters.

removeskill

int32

send_activation

int32

enum [1] -> 1: Send activation

undertime

int32

timezone_id

int32

location

int32

pref_shift_autoconfirm

int32

enum [-1, 1, -2]

daily_overtime

int32

overtime

int32

monthly_overtime

int32

monthly_undertime

int32

pref_mtimebshifts

int32

enum [0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48]

work_start_date

date

pref_sp_skin

string

enum [0, 1, 2] -> 0: ShiftPlanning; 1: Humanity; 2: Humanity permanent

employee_type

int32

Defaults to 0

enum [0, 1, 2, 3, 4, 5, 6]
0 - None
1 - Full Time
2 - Part Time
3 - Seasonal
4 - Temporary
5 - Contractor
6 - Volunteer

pay_type

int32

Defaults to 0

enum [0, 1, 2, 3, 4, 5, 6]
0 - None
1 - Hourly
2 - Salary
3 - Commission
4 - Exception Hourly
5 - Daily
6 - Weekly
7 - Monthly
8 - Piece Rate
9 - Contract
10 - Pro Rata

Responses

200200

400400