Skip to main content
PATCH
/
v1
/
leave-policies
/
{id}
Update a leave policy
curl --request PATCH \
  --url https://api.plane.com/v1/leave-policies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": {},
  "status": "<string>",
  "type": "<string>",
  "effect": "<string>",
  "unit": "<string>",
  "applies": {},
  "period": {},
  "accrual": {},
  "carryover": {},
  "balance": {},
  "usage": {},
  "payout": {}
}
'

​
Parameters

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

​
Returns

Returns the updated Leave Policy object.