You are viewing an old version of the API

All Versions

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 3 BreakType instances per location. If you attempt to add a 4th 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

Request Body

Example code

Name	Description
`idempotency_key string`	Unique string value to insure idempotency of the operation Max Length 128
`break_type BreakType` Required	The `BreakType` to be created.

Response Fields

Name	Description
`break_type BreakType`	The `BreakType` that was created by the request.
`errors Error [ ]`	Any errors that occurred during the request.

Examples

POST /v2/labor/break-types

curl https://connect.squareup.com/v2/labor/break-types \
  -X POST \
  -H 'Square-Version: 2021-04-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "PAD3NG5KSN2GL",
    "break_type": {
      "location_id": "CGJN03P1D08GF",
      "break_name": "Lunch Break",
      "expected_duration": "PT30M",
      "is_paid": true
    }
  }'

{
  "break_type": {
    "id": "49SSVDJG76WF3",
    "location_id": "CGJN03P1D08GF",
    "break_name": "Lunch Break",
    "expected_duration": "PT30M",
    "is_paid": true,
    "version": 1,
    "created_at": "2019-02-26T22:42:54Z",
    "updated_at": "2019-02-26T22:42:54Z"
  }
}

Labor API You are viewing an old version of the API 2021-04-21 Version 2021-04-21 All Versions Labor API Create break type

Request Body

Response Fields

Examples

Share Feedback

You are viewing an old version of the API

All Versions

Create break type