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_idbreak_nameexpected_durationis_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.
Servers
- https://connect.squareup.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
break_type |
Object | Yes |
A defined break template that sets an expectation for possible |
break_type.id |
String | No |
The UUID for this object. |
break_type.location_id |
String | Yes |
The ID of the business location this type of break applies to. |
break_type.expected_duration |
String | Yes |
Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision less than minutes is truncated. |
break_type.version |
Integer | No |
Used for resolving concurrency issues. The request fails if the version provided does not match the server version at the time of the request. If a value is not provided, Square's servers execute a "blind" write; potentially overwriting another writer's data. |
break_type.created_at |
String | No |
A read-only timestamp in RFC 3339 format. |
break_type.is_paid |
Boolean | Yes |
Whether this break counts towards time worked for compensation purposes. |
break_type.break_name |
String | Yes |
A human-readable name for this type of break. The name is displayed to employees in Square products. |
break_type.updated_at |
String | No |
A read-only timestamp in RFC 3339 format. |
idempotency_key |
String | No |
A unique string value to ensure the idempotency of the operation. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.