create-break-type-request.md

Create Break Type Request

A request to create a new BreakType

Structure

Create Break Type Request

Fields

Name	Type	Tags	Description
idempotency_key	string	Optional	Unique string value to insure idempotency of the operation Constraints: Maximum Length: 128
break_type	Break Type	Required	A defined break template that sets an expectation for possible Break instances on a Shift.

Example (as JSON)

{
  "break_type": {
    "break_name": "Lunch Break",
    "expected_duration": "PT30M",
    "is_paid": true,
    "location_id": "CGJN03P1D08GF"
  },
  "idempotency_key": "PAD3NG5KSN2GL"
}