---
title: "Create a break"
method: POST
path: "/api/business/{businessId}/branch/{branchId}/break"
tags: ["Break"]
---

# Create a break

`POST /api/business/{businessId}/branch/{branchId}/break`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/break`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/break/post.ts> (a function with typed inputs; its response is checked against the schema)

Create and return a break for the specified business id and branch id

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Request body

- BreakCreateRequest
  - `breakDate` string, date
  - `startTime` string
  - `endTime` string
  - `staffId` string
  - `roomId` string
  - `machineId` string
  - `label` string
  - `paidBreak` boolean
  - `breakId` string
  - `version` integer

## Response `201`

Break created successfully

- BreakResponse
  - `breakDate` string, date
  - `startTime` string
  - `endTime` string
  - `staffId` string
  - `roomId` string
  - `machineId` string
  - `label` string
  - `paidBreak` boolean
  - `breakId` string
  - `version` integer

## Other responses

- `400`: Bad Request
- `404`: Business or branch with the specified ids don't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/phorest/apis/third-party-api.md) - [All operations](https://skmtc.dev/phorest/apis/third-party-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phorest/apis/third-party-api/revisions/beea6ef29634?raw)