Update Time Off Policy

patch

https://{companyDomain}.bamboohr.com/api/v1/time-off/policies/{id}

Partially updates a time off policy using JSON Merge Patch semantics. A supplied version replaces the complete accrual schedule by archiving overlapping versions and creating a new version, matching admin Edit Schedule.

OAuth Scopes: time_off:policies.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The time off policy ID.

Body Params

Data contract for partially updating a time off policy. All fields are optional, but at least one must be supplied. The version replaces the complete accrual schedule.

name

string

length ≤ 100

The policy name. Must be unique among active policies in the category.

version

object

The complete replacement accrual schedule. Only valid for ACCRUING policies.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/merge-patch+json

Generated from available request content types

Allowed:

Responses

200The updated time off policy.

400Malformed request body.

401Unauthorized. Missing or invalid authentication.

403Forbidden. The caller may not manage time off policies.

404The time off policy does not exist.

409Another active policy in this category already uses the requested name.

422The request body failed validation, or attempted to change type or categoryId.