Assign Time Off Policies (v1)

Deprecated. Use Assign Time Off Policies (v1.1) instead (assign-time-off-policies-v1_1). Assigns time off policies to an employee with accruals starting on the specified date. A null start date removes the existing assignment. On success, returns the current list of assigned policies.

OAuth Scopes: time_off.write

put/api/v1/employees/{employeeId}/time_off/policies

Request

Base URL
https://companySubDomain.bamboohr.com
Auth
- HTTP basic
- or OAuth 2
  Authorization code/authorize.php
  Token URL/token.php
  Scopestime_off.write
TypeScript
https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/employees/:employeeId/time_off/policies/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

employeeIdinteger required

The internal employee ID of the employee whose time off policies are being assigned.

Request body

timeOffPolicyIdinteger required

The ID of the time off policy to assign.

accrualStartDatestring date nullable required

The date accruals should start in YYYY-MM-DD format. Set to null to remove an existing assignment.

Example request

[
  {
    "timeOffPolicyId": 4,
    "accrualStartDate": "2024-02-01"
  },
  {
    "timeOffPolicyId": 5,
    "accrualStartDate": null
  }
]

Response

The current list of assigned policies for the employee.

timeOffPolicyIdinteger

The ID of the assigned time off policy.

timeOffTypeIdinteger

The ID of the time off type.

accrualStartDatestring date

The date accruals started in YYYY-MM-DD format.

Changes

No recorded changes to this operation across all 2 revisions of this API.