Update Break

patch

https://{companyDomain}.bamboohr.com/api/v1/time-tracking/breaks/{id}

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

OAuth Scopes: time_tracking:breaks.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The break ID.

Body Params

Data contract for partially updating a break. All fields are optional; only fields present in the request body will be updated.

name

string

The name of the break

policyId

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

enum

When the break is available to be taken

Allowed:

availabilityMinHoursWorked

Minimum hours that must be worked before the break can be taken

availabilityMaxHoursWorked

Maximum hours that can be worked before the break must be taken

availabilityStartTime

Earliest time the break can be taken (HH:MM format)

availabilityEndTime

Latest time the break can be taken (HH:MM format)

Responses

200Successfully updated break

403Forbidden

422Invalid request data