PUT Employee

/employees/:id Permission level: 5

put/employees/{id}

Request

  • Base URL
    https://www.humanity.com/api/v2
  • Auth
    API key in query parameter access_token

Path parameters

idinteger required

Request body application/x-www-form-urlencoded

job_titlestring
notesstring
eidstring
unique_idstring

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

first_namestring
groupstring

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

statusstring

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

namestring
last_namestring
nick_namestring
emailstring
wageinteger
cell_phonestring
birth_dayinteger
birth_monthinteger
p_emailinteger

enum [0, 1]

p_phoneinteger

enum [0, 1]

statestring
addressstring
home_phonestring
citystring
zipstring
genderstring

enum['M','F']

middle_namestring
max_days_rowinteger
customstring

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

languagestring
removeschedulestring

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

smsgatewayinteger
passwordstring

Minimum 6 characters.

addskillinteger

Skill ID

addschedulestring

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

usernamestring

Minimum 3 characters.

removeskillinteger
send_activationinteger

enum [1] -> 1: Send activation

undertimeinteger
timezone_idinteger
locationinteger
pref_shift_autoconfirminteger

enum [-1, 1, -2]

daily_overtimeinteger
overtimeinteger
monthly_overtimeinteger
monthly_undertimeinteger
pref_mtimebshiftsinteger

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

work_start_datestring date
pref_sp_skinstring

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

employee_typeinteger

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

pay_typeinteger

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

Response

200

statusinteger
tokenstring
errorunknown

Example response

{
  "status": 1,
  "data": {
    "id": "3997029",
    "username": "mikestan",
    "email": "michael.stanley.333@mail.com",
    "realname": "Mike",
    "location": "0",
    "email_setting": "1",
    "notify_with_post": "0",
    "auto_notify": "0",
    "show_smilies": "1",
    "show_img": "1",
    "show_img_sig": "1",
    "show_avatars": "1",
    "show_sig": "1",
    "access_keys": "0",
    "timezone": "314",
    "dst": "0",
    "time_format": "0",
    "date_format": "0",
    "style": "ShiftPlanning",
    "num_posts": "0",
    "registered": "1523636522",
    "registration_ip": "82.117.214.54",
    "last_visit": "0",
    "last_active": "0",
    "pun_bbcode_enabled": "1",
    "pun_bbcode_use_buttons": "1",
    "pun_pm_long_subject": "1",
    "newsletter": "1",
    "email_confirmed": "0",
    "status": "1",
    "deleted": "0",
    "deleted_by": "0",
    "legal_agree": "0",
    "referral": "0",
    "name": "Mike",
    "firstname": "Michael",
    "lastname": "Stanley",
    "nick_name": "Mike",
    "birth_day": "0",
    "birth_month": "0",
    "cellphone_confirmed": "0",
    "last_sms_sent": "0",
    "avatar": {
      "small": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png",
      "medium": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png",
      "large": "https://d3l54fgzztlejs.cloudfront.net/app/layout/images/no_avatar.png"
    },
    "city": "Dallas",
    "state": "Texas",
    "notes": "Has CCNP certificate",
    "p_email": "1",
    "p_phone": "1",
    "notify_sms": "-1",
    "notify_email": "1",
    "e_new_pm": "0",
    "ical": "https://www.humanity.com/ical/63003e011dcbce011aa0d9d426017f3b.ics",
    "24hr": "0",
    "startday": "1",
    "pref_caltime": "10",
    "pref_shift_autoconfirm": "-1",
    "undertime": "0",
    "overtime": "-1",
    "recommend": "0",
    "tut_v2_sched": "0",
    "daily_overtime": "0",
    "max_days_row": "-1",
    "monthly_undertime": "0",
    "monthly_overtime": "-1",
    "pref_mtimebshifts": "0",
    "deactivated": "0",
    "work_start_date": "2018-04-13 18:22:02",
    "screen_logger": "0",
    "sc_freq": "-2",
    "newsletter_receiver": "0",
    "gender": "M",
    "pref_sp_skin": "1",
    "teamtools_id": "0",
    "updated_at": "2018-04-13 18:47:48",
    "employee_type": "0",
    "pay_type": "0",
    "group": "5",
    "timezone_name": "Europe/Belgrade",
    "group_name": "Employee",
    "status_name": "Activated",
    "schedules": {
      "1819357": "New funky job"
    },
    "skills": {
      "82458": "Oracle certified"
    },
    "custom": {
      "26768": {
        "id": "26768",
        "name": "PTO balance [hours]",
        "type": "1",
        "access": "1"
      },
      "27043": {
        "id": "27043",
        "name": "CF2",
        "type": "1",
        "access": "1",
        "value": "New value for the custom field with ID 27043",
        "toggle": "0"
      },
      "27044": {
        "id": "27044",
        "name": "Checkbox CF",
        "type": "4",
        "access": "1"
      }
    },
    "settings": {
      "widgets_layout": [
        [
          "timeclock"
        ]
      ],
      "schedule_side_panel_visibility": 1,
      "linked_shift_time": 1,
      "schedule_view_selected": "week",
      "schedule_timeline_selected": "employee"
    }
  },
  "token": "xxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.