Create break type

POST

/v2/labor/break-types

Creates a new BreakType.

A BreakType is a template for creating Break objects. You must provide the following values in your request to this endpoint:

location_id
break_name
expected_duration
is_paid

You can only have three BreakType instances per location. If you attempt to add a fourth BreakType for a location, an INVALID_REQUEST_ERROR "Exceeded limit of 3 breaks per location." is returned.

Permissions:TIMECARDS_SETTINGS_WRITE

Try in API Explorer

Link to section

Request body

Example code

Link to section

idempotency_key

string

A unique string value to ensure the idempotency of the operation.

Max Length

128

Link to section

break_type

Required

The BreakType to be created.

Link to section

Response fields

Link to section

break_type

The BreakType that was created by the request.

Link to section

errors

Any errors that occurred during the request.