Create desk

Creates a desk and assigns users to it.

Parameters. name (required): the desk name. userIds (required): the IDs of the users to assign to the desk. Returns. { "userDesk": { ... } } with the created desk, including its id, name and userIds. Example.

{ "name": "Desk-English", "userIds": [1] }

post/{sub_domain}/api/desks

Request

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

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

namestring required

The 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.