Create Time Off Policy

post

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

Creates a time off policy. Accruing policies include an inlined initial version with milestones; unlimited and manual policies have no version.

OAuth Scopes: time_off:policies.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Data contract for creating a time off policy. Accruing policies include an inlined initial version with milestones; unlimited and manual policies have no version.

name

string

required

length ≤ 100

The name of the time off policy. Must be unique among the category's active policies.

categoryId

integer

required

The id of the time off category this policy belongs to.

type

string

enum

required

The type of the time off policy.

Allowed:

version

The initial version of the policy, with its milestones inlined. Required for ACCRUING policies; must be omitted for UNLIMITED and MANUAL.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201The created time off policy, including currentVersion for accruing policies.

400Malformed request body.

401Unauthorized. Missing or invalid authentication.

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

404The referenced time off category does not exist.

409A policy with the same name already exists in the category.

422The request body failed validation.