---
title: "Update desk breaks"
method: POST
path: "/{sub_domain}/api/desks/desk-breaks/{id}"
tags: ["Desks"]
---

# Update desk breaks

`POST /{sub_domain}/api/desks/desk-breaks/{id}`

## Request

- Base URL: `https://api.commpeak.com/dialer`
- URL: `https://api.commpeak.com/dialer/{sub_domain}/api/desks/desk-breaks/{id}`
- Auth: API key in header `Authorization`

Configures which breaks are available to agents on a desk.

**Parameters.** `id` (path): the desk to update. `useGlobalBreaks` (boolean): set to true to use your account's global breaks, or false to use a custom set. `breakIds` (array): the break IDs to make available on the desk when using a custom set. The default break is always included.
**Returns.** `{ "userDesk": { ... } }` with the updated desk.
**Example.** `POST /api/desks/desk-breaks/5` with `{ "useGlobalBreaks": false, "breakIds": [2, 3, 6] }`

## Path parameters

- `id` integer, required: Desk ID.
- `sub_domain` string, required: Dialer Name (subdomain)

## Request body

- UserDeskBreaksInput
  - `useGlobalBreaks` boolean, nullable: Whether the desk should use the global breaks.
  - `breakIds` integer[], nullable: An array of break (state) IDs to assign to the desk. Break ID 1 is always included.

## Response `200`

Successful Response

- UserDeskSingleResponse
  - `userDesk` UserDeskItem, required: A user desk (group of users that share break/state policy).
    - `id` integer, nullable: Desk ID.
    - `name` string, nullable: Desk name.
    - `userIds` integer[], nullable: IDs of the users assigned to the desk.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-dialer-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/revisions/18c5edc07544?raw)