Routing Queues

Last updated 5 months ago

Was this helpful?

List routing queues

Retrieve list of routing queues

get

/workspaces/{workspaceId}/inbox/routing-queues

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/inbox/routing-queues' \
  --header 'Authorization: Bearer jwt'

200

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "priority": 1,
      "createdAt": "2025-02-21T18:03:07.922Z",
      "updatedAt": "2025-02-21T18:03:07.922Z",
      "teams": [
        {
          "type": "primary",
          "ids": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "queuedItems": {
        "email": [],
        "messaging": [],
        "voice": []
      }
    }
  ],
  "nextPageToken": "text",
  "total": 1
}

Create a routing queue

Create a new routing queue

post

/workspaces/{workspaceId}/inbox/routing-queues

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 1 · max: 255required

descriptionstring

priorityinteger · max: 100required

teamsobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/inbox/routing-queues' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","priority":1,"teams":[{"type":"primary","ids":[null]}]}'

201

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "priority": 1,
  "createdAt": "2025-02-21T18:03:07.922Z",
  "updatedAt": "2025-02-21T18:03:07.922Z",
  "teams": [
    {
      "type": "primary",
      "ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "queuedItems": {
    "email": [],
    "messaging": [],
    "voice": []
  }
}

created

Get routing queue

Retrieves Routing queue.

get

/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}

Authorizations

Path parameters

workspaceIdstringrequired

routingQueueIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "priority": 1,
  "createdAt": "2025-02-21T18:03:07.922Z",
  "updatedAt": "2025-02-21T18:03:07.922Z",
  "teams": [
    {
      "type": "primary",
      "ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "queuedItems": {
    "email": [],
    "messaging": [],
    "voice": []
  }
}

Update a Routing queue

Modify the details of a specific routing queue.

patch

/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}

Authorizations

Path parameters

workspaceIdstringrequired

routingQueueIdstringrequired

Body

namestring · min: 1 · max: 255

descriptionstring

priorityinteger · max: 100

teamsobject[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{"teams":[{"type":"primary","ids":[null]}]}'

200

404

422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "priority": 1,
  "createdAt": "2025-02-21T18:03:07.922Z",
  "updatedAt": "2025-02-21T18:03:07.922Z",
  "teams": [
    {
      "type": "primary",
      "ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "queuedItems": {
    "email": [],
    "messaging": [],
    "voice": []
  }
}

Updated

Delete a Routing queue

Delete a Routing queue. Items on the queue will be un-queued, then queue will be deleted.

delete

/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}

Authorizations

Path parameters

workspaceIdstringrequired

routingQueueIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/inbox/routing-queues/{routingQueueId}' \
  --header 'Authorization: Bearer jwt'

204

404

No body

Deleted