Skip to main content
PATCH
Update a leave policy

Parameters

string
required
The ID of the custom leave policy to update.
string
New human-readable policy name.
string | null
New plain-language explanation of the policy. Pass null to clear it.
string
New lifecycle state. One of draft, active, or archived.
string
New leave type, for example vacation or sick_time_off.
string
Whether the policy is a set or add policy.
string
Unit used for policy quantities. One of days or hours.
string | null
Optional CEL expression used for automatic matching against the worker resource shape. Pass null to clear it.
object
Updated period definition for the policy.
object | null
Updated accrual rule. Use null for unlimited leave.
object | null
Updated carryover rule. Use null for use-it-or-lose-it.
object | null
Updated balance bounds. Use null for unlimited leave.
object | null
Updated per-period usage cap.
object
Updated termination payout rule.

Returns

Returns the updated Leave Policy object.