Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 946 Bytes

create-break-type-request.md

File metadata and controls

34 lines (25 loc) · 946 Bytes

Create Break Type Request

A request to create a new BreakType.

Structure

CreateBreakTypeRequest

Fields

Name Type Tags Description Getter
IdempotencyKey String Optional A unique string value to ensure the idempotency of the operation.
Constraints: Maximum Length: 128		 String getIdempotencyKey()
BreakType BreakType Required A defined break template that sets an expectation for possible Break
instances on a Shift.		 BreakType getBreakType()

Example (as JSON)

{
  "break_type": {
    "break_name": "Lunch Break",
    "expected_duration": "PT30M",
    "is_paid": true,
    "location_id": "CGJN03P1D08GF",
    "id": "id8",
    "version": 132,
    "created_at": "created_at6",
    "updated_at": "updated_at4"
  },
  "idempotency_key": "PAD3NG5KSN2GL"
}