Update Time Off Category

patch

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

Partially updates a time off category using JSON Merge Patch semantics. Only fields present in the request body are changed. Setting enabled to false disables the category and removes it from payroll; disabling an already disabled category is a no-op. Changing unit converts every existing balance, request, and history amount for the category and requires hoursPerDay. Category names are unique among all of the company's categories, including disabled and deleted ones, so renaming onto a name already in use returns a 409 identifying the category that holds it. Accepts both application/merge-patch+json and application/json.

OAuth Scopes: time_off:categories.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The time off category ID.

Body Params

Data contract for partially updating a time off category. All fields are optional, but at least one must be supplied; only fields present in the request body are updated.

name

string

length ≤ 50

The name of the time off category. Must be unique among all of the company's categories, including disabled and deleted ones; a collision returns a 409 identifying the category that holds the name.

unit

string

enum

The unit of measurement for the time off category. Changing this converts every existing balance, request, and history amount for the category, and requires hoursPerDay.

Allowed:

color

enum

The color for the category, as a six character hex code without a leading "#". Must be one of the supported category colors. Send null to use the company color.

icon

string

The icon for the category.

paid

boolean

Whether time off in this category is paid.

includeInPayroll

boolean

Whether this category should be included in payroll. Only takes effect when the company has payroll with timecard auto sync enabled.

enabled

boolean

Whether the category is available for new time off requests. Setting this to false disables the category and also removes it from payroll. Disabling an already disabled category is a no-op.

hoursPerDay

number

1 to 24

The number of hours in a work day, used to convert existing amounts when unit changes. Required when unit differs from the category's current unit, and ignored otherwise.

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

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The updated time off category.

400Malformed request body.

401Unauthorized. Missing or invalid authentication.

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

404The time off category does not exist.

409A time off category (possibly disabled or deleted) already uses the requested name. The conflictingCategory member identifies the category holding it so the caller can resolve the conflict. Nothing is changed.

422The request body failed validation.