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

# Update desk

`PUT /{sub_domain}/api/desks/{id}`

## Request

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

Updates a desk's name and the set of users assigned to it.

**Parameters.** `id` (path): the desk to update. `name`: a new name for the desk. `userIds`: the full set of user IDs that should be assigned to the desk. Any user not in this list is removed from the desk.
**Returns.** `{ "userDesk": { ... } }` with the updated desk.
**Example.** `PUT /api/desks/5` with `{ "name": "Desk-English", "userIds": [2] }`

## Path parameters

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

## Request body

- UpdateUserDeskInput
  - `name` string, nullable: The updated name of the desk.
  - `userIds` integer[], nullable: An array of user IDs associated with the desk.

## 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)