Create Time Off Category

post

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

Creates a time off category. Category names are unique among all of the company's categories, including disabled and deleted ones; a name collision returns a 409 that identifies the conflicting category so the caller can resolve it (for example by choosing a different name).

OAuth Scopes: time_off:categories.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Data contract for creating a time off category.

name

string

required

length ≤ 50

The name of the time off category. Must be unique among the company's active categories.

unit

string

enum

required

The unit of measurement for the time off category.

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. Omit or send null to use the company color.

icon

The icon for the category. Omit to use the default icon.

paid

boolean

Defaults to true

Whether time off in this category is paid.

includeInPayroll

boolean

Defaults to false

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201The created time off category.

400Malformed request body.

401Unauthorized. Missing or invalid authentication.

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

409A time off category (possibly disabled or deleted) already uses the requested name. The response's conflictingCategory member identifies the category holding it (id, name, enabled, deleted), or is null when it could not be identified.

422The request body failed validation.