HUhubstaff
overtime_policies

Update overtime policy

Updates an overtime policy. Only pass in the fields you want to change.

Updatable fields: name, threshold, pay_rate_multiplier, auto_add_new_users, notification_enabled, notification_role_ids, and user_ids (member assignments).

Immutable after creation: policy_type. Editing an archived policy is not allowed.

Changes apply at the start of the organization's next week (for weekly policies) or the next day (for daily policies). A policy that is already in use is not edited in place — a new version is created and the current one is archived.

A member can only belong to one policy of a given type at a time. If any member in user_ids is already assigned to another active policy of the same type, the request fails unless override is true, in which case those members are moved into this policy.

Only organization Owners and Managers may use this endpoint.

put/v2/overtime_policies/{overtime_policy_id}

Request

Path parameters

overtime_policy_idinteger required

Overtime policy ID

Request body

namestring

Policy name (2-50 characters)

policy_type'daily' | 'weekly'

Cannot be changed once the policy is created

thresholdnumber float

Hours worked per period before overtime applies

pay_rate_multipliernumber float

Pay rate multiplier after the threshold

user_idsinteger[]

User IDs to set as the policy members

auto_add_new_usersboolean

Automatically add new members to this policy

notification_enabledboolean

Whether overtime notifications are sent

notification_role_idsstring[]

Roles notified about overtime

starts_onstring date

Scheduled start date (period-aligned)

overrideboolean

When assigning members, move any who are already on another active policy of the same type into this one. Without it, the request fails if any assigned member is already on such a policy.

Response

An overtime policy

Changes

No recorded changes to this operation across all 1 revision of this API.