GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Update a time off policy

Update a time off policy

scope: time_off_policies:write

Path Params
string
required

The UUID of the time off policy

Body Params
string
required

The current version of the object. See the versioning guide for information on how to use this field.

string

Name of the time off policy

string
enum

Type of the time off policy. Currently only "vacation" and "sick" are supported

Allowed:
string
enum

Accrual method of the time off policy

string | null

The rate at which the time off hours will accrue for an employee on the policy. Represented as a float, e.g. "40.0".

string | null

The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float, e.g. "40.0".

boolean

Boolean representing if an employee's accrued time off hours will be paid out on termination

integer | null

Number of days before an employee on the policy will begin accruing time off hours. If accrual_method is per_anniversary_year, per_calendar_year, or unlimited, then accrual_waiting_period_days should be 0.

string | null

The max number of hours an employee can carryover from one year to the next. If accrual_method is unlimited, then carryover_limit_hours must be blank.

string | null

The max number of hours an employee can accrue in a year. If accrual_method is yearly (per_anniversary_year, per_calendar_year) or unlimited, then max_accrual_hours_per_year must be blank.

string | null

The max number of hours an employee can accrue. If accrual_method is unlimited, then max_hours must be blank.

string | null

The date the policy resets. Format MM-DD

boolean

boolean representing if a policy has completed configuration

Headers
string
enum
Defaults to 2026-02-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json