• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
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

Request Body

Example code
Name Description
idempotency_key
string

A unique string value to ensure the 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

You are viewing an old version of the API
POST /v2/labor/break-types
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/labor/break-types \
  -X POST \
  -H 'Square-Version: 2022-11-16' \
  -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
    }
  }'
Response JSON 
{
  "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"
  }
}