---
title: "Create Break Policy"
method: POST
path: "/api/v1/time-tracking/break-policies"
tags: ["Meal & Rest Breaks", "Public API"]
---

# Create Break Policy

`POST /api/v1/time-tracking/break-policies`

Create a break policy. Breaks and assignments can be optionally included and created at the same time.

OAuth Scopes: time_tracking:breaks.write

## Request body

- TimeTrackingCreateTimeTrackingBreakPolicyV1 — Data contract for creating a break policy
  - `name` string, required — Name of the break policy
  - `description` string, nullable — Optional description of the break policy
  - `allEmployeesAssigned` boolean — Whether all employees are assigned to this break policy
  - `breaks` TimeTrackingCreateOrUpdateTimeTrackingBreakWithoutPolicyV1[] — Collection of time tracking breaks to create or update without a policy
    - `id` string, uuid, nullable — The unique identifier of the break. If not included, a new break will be created.
    - `name` string — The name of the break
    - `paid` boolean — Whether the break is paid
    - `duration` integer — Duration of the break in minutes
    - `availabilityType` 'anytime' | 'hours_worked' | 'time_of_day' — When the break is available to be taken
    - `availabilityMinHoursWorked` number, float, nullable — Minimum hours that must be worked before the break can be taken
    - `availabilityMaxHoursWorked` number, float, nullable — Maximum hours that can be worked before the break must be taken
    - `availabilityStartTime` string, time, nullable — Earliest time the break can be taken (HH:MM format)
    - `availabilityEndTime` string, time, nullable — Latest time the break can be taken (HH:MM format)
  - `employeeIds` integer[] — The employees that should be assigned to this policy

## Response `201`

Successfully created a break policy

- TimeTrackingTimeTrackingBreakPolicyWithRelationsV1 — A break policy for time tracking
  - `id` string, uuid — Unique identifier for the break policy
  - `name` string — Name of the break policy
  - `description` string, nullable — Optional description of the break policy
  - `allEmployeesAssigned` boolean — Whether all employees are assigned to this break policy
  - `createdAt` string, date-time — ISO 8601 timestamp when the break policy was created
  - `updatedAt` string, date-time, nullable — ISO 8601 timestamp when the break policy was last updated
  - `deletedAt` string, date-time, nullable — ISO 8601 timestamp when the break policy was deleted
  - `breaks` TimeTrackingTimeTrackingBreakV1[] — The breaks that are assigned to this policy
    - `id` string, uuid — The unique identifier for the time tracking break
    - `name` string — The name of the break
    - `policyId` string, uuid — The unique identifier of the break policy this break belongs to
    - `paid` boolean — Whether the break is paid
    - `duration` integer — Duration of the break in minutes
    - `availabilityType` 'anytime' | 'hours_worked' | 'time_of_day' — When the break is available to be taken
    - `availabilityMinHoursWorked` number, float, nullable — Minimum hours that must be worked before the break can be taken
    - `availabilityMaxHoursWorked` number, float, nullable — Maximum hours that can be worked before the break must be taken
    - `availabilityStartTime` string, time, nullable — Earliest time the break can be taken (HH:MM format)
    - `availabilityEndTime` string, time, nullable — Latest time the break can be taken (HH:MM format)
    - `createdAt` string, date-time — ISO 8601 timestamp when the break was created
    - `updatedAt` string, date-time, nullable — ISO 8601 timestamp when the break was last updated
    - `deletedAt` string, date-time, nullable — ISO 8601 timestamp when the break was deleted
  - `employeeIds` integer[] — The employees that are assigned to this policy

## Other responses

- `403` — Forbidden
- `422` — Invalid request data

---

[API](https://skmtc.net/bamboohr/apis/bamboohr-api.md) · [All operations](https://skmtc.net/bamboohr/apis/bamboohr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bamboohr/bamboohr-api/revisions/19ebf391a399/schema)