v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Meal & Rest Breaks

Public API

Update Break Policy

Partially updates a break policy identified by its UUID. Only fields provided in the request body are updated. Returns the updated break policy on success.

OAuth Scopes: time_tracking:breaks.write

patch/api/v1/time-tracking/break-policies/{id}

Path parameters

idstring uuid required

The break policy ID.

Request body

namestring

Name of the break policy

descriptionstring nullable

Optional description of the break policy

allEmployeesAssignedboolean

Whether all employees are assigned to this break policy

Example request

{
  "name": "California",
  "description": "All breaks for California compliance",
  "allEmployeesAssigned": true
}

Response

Break policy updated successfully

idstring uuid

Unique identifier for the break policy

namestring

Name of the break policy

descriptionstring nullable

Optional description of the break policy

allEmployeesAssignedboolean

Whether all employees are assigned to this break policy

createdAtstring date-time

ISO 8601 timestamp when the break policy was created

updatedAtstring date-time nullable

ISO 8601 timestamp when the break policy was last updated

deletedAtstring date-time nullable

ISO 8601 timestamp when the break policy was deleted

Example response

{
  "id": "0199de9b-6bcb-77e7-941d-3caf74b9a372",
  "name": "California",
  "description": "All breaks for California compliance",
  "allEmployeesAssigned": true,
  "createdAt": "2025-10-15T06:00:00Z",
  "updatedAt": "2025-10-15T06:00:00Z",
  "deletedAt": "2025-10-15T06:00:00Z"
}