Update desk breaks

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

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

Path parameters

idinteger required

Desk ID.

sub_domainstring required

Dialer Name (subdomain)

Request body

useGlobalBreaksboolean nullable

Whether the desk should use the global breaks.

breakIdsinteger[] nullable

An array of break (state) IDs to assign to the desk. Break ID 1 is always included.

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.