Update desk

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] }

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

Path parameters

idinteger required

Desk ID.

sub_domainstring required

Dialer Name (subdomain)

Request body

namestring nullable

The updated name of the desk.

userIdsinteger[] nullable

An array of user IDs associated with the desk.

Response

Successful Response

Example response

{
  "userDesk": {
    "id": 93,
    "name": "Demo Desk",
    "userIds": [
      969,
      178,
      721,
      795,
      796
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.