PUT Company Settings

Changed on

/companies/:id/settings Permission level: 2

put/company/settings

Request

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

Request body application/x-www-form-urlencoded

admin_past_editinteger

enum[0,1]

book_days_offinteger

enum[0,1]

book_days_off_advinteger

number of days

confirm_trade_afterinteger

enum[0,1]

confirm_trade_beforeinteger

enum[0,1]

coworkers_contactsinteger

enum[0,1]

emailinteger

enum[0,1]

future_availinteger

enum[0,1]

message_wall_commentsinteger

enum[0,1]

message_wall_empinteger

enum[0,1]

message_wall_oninteger

enum[0,1]

on_nowinteger

enum[0,1]

overtimeinteger

Daily overtime - max number of hours

pminteger

enum[0,1]

pref_allow_req_accinteger

enum[0,1]

pref_alt_w_overtime_calcinteger

enum[0,1]

pref_availability_timeframeinteger

AvailabilityChangeRequests are effective **0 – Immediatly *1 – after one day 2 – after two days 7 – after one week

pref_birthdayinteger

enum[0,1]

pref_birthday_cardinteger

enum[0,1]

pref_birthday_reminderinteger

enum[0,1]

shift_confirminteger

enum[0,1]

smsinteger

enum[0,1]

tc_autoclockoutinteger

enum[0,1]

tc_clock_in_timeframeinteger
tc_round_tointeger
tc_terminal_lockinteger

enum[0,1]

tc_webcaminteger

enum[0,1]

timeclockinteger

enum[0,1]

trade_shiftsinteger

enum[0,1]

visible_coworkersinteger

enum[0,1]

visible_overviewinteger

enum[0,1]

visible_owninteger

enum[0,1]

visible_staffinteger

enum[0,1]

visible_staff_detailsinteger

enum[0,1]

weekly_availinteger

enum[0,1]

Response

200

statusinteger
errorunknown

Example response

{
  "status": 1,
  "data": {
    "admin_past_edit": "0",
    "edit_profile": "1",
    "reports": "1",
    "book_days_off": "1",
    "book_days_off_adv": "-1",
    "book_days_off_max": "30",
    "confirm_trade_before": "0",
    "confirm_trade_after": "1",
    "sms": "1",
    "email": "1",
    "pm": "1",
    "visible_staff": "1",
    "visible_staff_details": "1",
    "visible_coworkers": "0",
    "trade_shifts": "1",
    "coworkers_contacts": "0",
    "future_avail": "1",
    "weekly_avail": "1",
    "visible_overview": "1",
    "visible_own": "1",
    "timeout": "0",
    "message_wall_on": "1",
    "message_wall_emp": "1",
    "message_wall_comments": "1",
    "message_wall_uploads": "0",
    "on_now": "1",
    "shift_confirm": "1",
    "shift_drop": "1",
    "shift_autoconfirm": "0",
    "timeclock": "1",
    "tc_terminal_lock": "0",
    "tc_round_to": "-1",
    "tc_round_to_in": "-1",
    "tc_round_to_out": "-1",
    "tc_clock_in_timeframe": "-1",
    "tc_autoclockout": "18.0",
    "tc_webcam": "0",
    "tc_empl_import": "1",
    "tc_empl_addtime": "0",
    "24hr": "1",
    "draft": "1",
    "date": "M j, Y",
    "startday": "2",
    "currency": "1",
    "viewadvance": "-1",
    "login_splogo": "0",
    "scosting": "1",
    "start_day": "1",
    "end_day": "7",
    "start_time": "33",
    "end_time": "85",
    "overtime": "45",
    "timezone": "-05:00,0",
    "availability_timeframe": "0",
    "alt_w_overtime_calc": "0",
    "birthday_card": "1",
    "oncall_manage": "1",
    "allow_req_acc": "0",
    "security_question": "who is our mascot",
    "security_answer": "wizard",
    "settings": "{\"emailsig_redirect_url\":\"\",\"pref_vacation_weekdays\":\"[\"0\",\"6\"]\",\"pref_tc_clock_in_after_timeframe\":\"-1\",\"pref_tc_clock_out_after_timeframe\":\"-1\",\"country\":\"227\",\"timezone_id\":\"314\",\"language\":\"en_US\",\"pref_date\":\"M j, Y\",\"pref_24hr\":\"1\",\"pref_week_adjust\":\"0\",\"pref_restrict_referrals\":0,\"pref_email\":\"1\",\"pref_sms\":\"1\",\"pref_email_force\":0,\"pref_birthday\":0,\"pref_birthday_card\":\"1\",\"sort_location\":0,\"pref_show_location_in_shift\":\"1\",\"pref_show_overnight_shifts\":\"1\",\"pref_startday\":\"2\",\"pref_draft\":\"1\",\"pref_shift_confirm\":\"1\",\"pref_viewadvance\":\"-1\",\"pref_scosting\":\"1\",\"pref_trade_shifts\":\"1\",\"pref_swap_shifts\":\"1\",\"pref_same_day_trades\":0,\"pref_dont_show_overlapping_shifts_in_trades\":0,\"pref_disable_shift_trade_between_positions\":0,\"pref_confirm_trade_before\":0,\"pref_confirm_trade_after\":\"1\",\"pref_visible_overview\":\"1\",\"pref_visible_own\":\"1\",\"pref_visible_coworkers\":0,\"pref_shift_drop\":\"1\",\"pref_shift_autoconfirm\":0,\"pref_open_overtime\":0,\"pref_mintimebshifts\":\"24\",\"pref_min_disregard\":0,\"max_days_row\":\"30\",\"pref_show_midnight\":\"1\",\"pref_oncall_manage\":\"1\",\"pref_employee_see_vacations\":\"1\",\"pref_sched_show_skill\":\"1\",\"pref_work_units\":0,\"pref_work_units_employees\":0,\"pref_schedulers_workunit_autoapproved\":0,\"pref_wu_emp_can_see_report\":0,\"pref_tasks\":\"1\",\"pref_24h_shift\":0,\"pref_schedule_notes\":\"1\",\"pref_schedule_notes_permissions\":\"7\",\"do_not_initiate_conflicts\":0,\"pref_shift_acknowledgement\":0,\"pref_shift_acknowledgement_notify\":\"1\",\"pref_show_pending_leaves_on_schedule\":\"1\",\"pref_see_shift_notes_perm\":\"7\",\"pref_task_modal\":\"0\",\"pref_employee_nameformat\":\"F L\",\"pref_training\":\"1\",\"pref_training_to_pdf\":0,\"pref_reports\":\"1\",\"pref_payroll_reports\":\"1\",\"pref_edit_profile\":\"1\",\"pref_visible_staff\":\"1\",\"pref_visible_staff_details\":\"1\",\"pref_staff_visible_eid\":0,\"pref_on_now\":\"1\",\"pref_allow_req_acc\":0,\"security_question\":\"who is our mascot\",\"security_answer\":\"wizard\",\"pref_employee_files\":\"1\",\"show_upcoming_birthdays\":\"1\",\"allow_schedulers_to_create_delete_users\":\"1\",\"pref_send_email_via_emailclient\":0,\"pref_timeclock\":\"1\",\"pref_tc_webcam\":0,\"pref_tc_webcam_mobile\":0,\"pref_webcam_resolution\":\"320\",\"pref_tc_gps\":\"1\",\"pref_tc_unavailable_gps\":\"1\",\"pref_tc_address\":\"1\",\"pref_pre_time_clock\":0,\"pref_mandatory_pre_time_clock\":0,\"pref_tc_empl_import\":\"1\",\"pref_tc_empl_addtime\":0,\"pref_tc_empl_edittime\":0,\"pref_tc_prevent_empl_edittime_approved\":0,\"pref_tc_prevent_empl_addclock_x_days\":\"0\",\"pref_tc_terminal_lock\":0,\"pref_tc_require_pos\":\"1\",\"pref_tc_require_remote_site\":0,\"pref_tc_require_notes\":0,\"pref_tc_round_to\":\"-1\",\"pref_tc_round_to_in\":\"-1\",\"pref_tc_round_to_in_direction\":\"1\",\"pref_tc_round_to_out\":\"-1\",\"pref_tc_round_to_out_direction\":\"1\",\"pref_tc_clock_in_timeframe\":\"-1\",\"pref_tc_clock_out_timeframe\":\"-1\",\"pref_enable_break_button\":\"1\",\"pref_admin_clockin_reminder_schedulers\":\"[\"15\"]\",\"pref_admin_clockin_reminder_managers\":\"[\"15\"]\",\"pref_admin_clockout_reminder_schedulers\":\"[]\",\"pref_admin_clockout_reminder_managers\":\"[]\",\"pref_tc_timeframe_notify\":null,\"pref_tc_autoclockout\":\"18\",\"pref_restrict_overlapping_timesheets\":0,\"show_timesheet_notes\":\"1\",\"pref_mandatory_notes\":0,\"pref_emp_can_edit_tc_without_providing_reason\":\"1\",\"pref_tc_tips\":\"1\",\"pref_timeclock_show_scheduled_details\":\"1\",\"pref_tc_screenshot\":0,\"pref_tc_screen_freq\":\"3\",\"pref_tc_screen_quality\":\"10\",\"pref_tc_screen_schedules\":null,\"pref_weekly_avail\":\"1\",\"pref_vacation_show_deleted\":0,\"pref_future_avail\":\"1\",\"pref_approve_availability\":\"1\",\"pref_sched_can_approve_past_vacations\":\"1\",\"pref_vac_req_only_schedulers\":0,\"pref_sched_can_approve_availability\":\"1\",\"pref_book_days_off\":\"1\",\"pref_book_days_off_adv\":\"-1\",\"pref_book_days_off_max\":\"30\",\"pref_vacation_max_days\":25,\"pref_availability_timeframe\":\"0\",\"pref_employee_delete_vacations\":\"1\",\"overtime_module\":\"default\",\"pref_cot_order15\":0,\"daily_overtime\":\"24\",\"overtime\":\"45\",\"monthly_overtime\":\"-2\",\"pref_request_deduct_breaks\":0,\"pref_currency\":\"1\",\"export_provider\":\"1\",\"company_code\":\"1111\",\"batch_id\":\"999\",\"fixed_batch_id\":\"1\",\"regular_hour_code\":\"101\",\"special_hour_code\":\"201\",\"overtime_hour_code\":\"301\",\"export_payrate\":0,\"company_name\":\"Shiftplanning\",\"company_created_time\":\"2016-04-14\",\"rate_of_pay\":\"\",\"pref_alt_w_overtime_calc\":0,\"pref_overtime_per_position\":0,\"pref_approve_overtime\":0,\"pref_allow_scheduler_to_see_wages\":0,\"pref_allow_scheduler_to_see_budget\":0,\"pref_allow_scheduler_to_edit_budget\":0,\"allow_schedulers_payroll_report\":0,\"num_of_decimals\":\"2\",\"pref_message_wall_on\":\"1\",\"pref_message_wall_emp\":\"1\",\"pref_message_wall_comments\":\"1\",\"pref_messaging_system\":\"1\",\"pref_pm\":\"1\",\"pref_ping\":\"1\",\"pref_login_google\":0,\"pref_login_facebook\":0,\"pref_login_twitter\":0,\"pref_login_openid\":0,\"pref_login_splogo\":0,\"autologout\":\"0\",\"password_expire\":\"0\",\"groupforce\":[],\"payroll\":{\"company_code\":\"1111\",\"batch_id\":\"999\",\"fixed_batch_id\":1,\"regular_hour_code\":\"101\",\"special_hour_code\":\"201\",\"overtime_hour_code\":\"301\",\"company_name\":\"Shiftplanning\",\"company_created_time\":\"2016-04-14\",\"export_provider\":\"1\",\"autologout\":\"0\",\"rate_of_pay\":\"\",\"export_payrate\":null,\"qb_position_to_item\":null,\"export_amount\":null},\"allow_multiple_filters_in_reports\":0,\"pref_only_managers_can_change_staff_password\":0,\"pref_employees_workunit_autoapproved\":0,\"pref_restrict_empl_clockinout\":0,\"pref_timeclock_show_breaks_mts\":\"1\",\"qb_position_to_item\":0,\"pref_messaging_module\":\"1\",\"pref_pm_reply\":\"1\",\"pref_leave_enabled\":\"1\",\"pref_integrations\":0,\"export_amount\":0}"
  }
}

Changes