Capacity Rules

List capacity rules

get

Retrieve list of capacity rule

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstring · max: 8000Optional

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

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

OK

application/json

get

/workspaces/{workspaceId}/inbox/capacity

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/inbox/capacity HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "results": [
    {
      "id": "text",
      "workspaceId": "text",
      "name": "text",
      "description": "text",
      "default": true,
      "capacity": {
        "messaging": 1,
        "email": 1
      },
      "assignedAgentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}

Create Capacity Rule

post

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

Body

application/json

namestring · min: 1 · max: 255Required

descriptionstring · min: 1 · max: 255Required

defaultbooleanOptional

agentsstring · uuid[]Optional

Responses

201

Created a Capacity Rule.

application/json

409

Default capacity rule already exists

application/json

422

Invalid input

application/json

post

/workspaces/{workspaceId}/inbox/capacity

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/inbox/capacity HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "name": "text",
  "description": "text",
  "default": true,
  "capacity": {
    "messaging": 1,
    "email": 1
  },
  "agents": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "default": true,
  "capacity": {
    "messaging": 1,
    "email": 1
  },
  "assignedAgentIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "text",
  "updatedAt": "text"
}

Get a Capacity Rule

get

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

capacityRuleIdstringRequired

Responses

200

ok

application/json

404

Workspace or Capacity Rule not found

application/json

get

/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "default": true,
  "capacity": {
    "messaging": 1,
    "email": 1
  },
  "assignedAgentIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "text",
  "updatedAt": "text"
}

Update Capacity Rule

patch

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

capacityRuleIdstringRequired

Body

application/json

namestringOptional

descriptionstringOptional

defaultbooleanOptional

Responses

200

Updated

application/json

404

Workspace or queue found

application/json

409

Default capacity rule already exists

application/json

422

Invalid queue

application/json

patch

/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "name": "text",
  "description": "text",
  "default": true,
  "capacity": {
    "messaging": 1,
    "email": 1
  }
}

{
  "id": "text",
  "workspaceId": "text",
  "name": "text",
  "description": "text",
  "default": true,
  "capacity": {
    "messaging": 1,
    "email": 1
  },
  "assignedAgentIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdAt": "text",
  "updatedAt": "text"
}

Delete a Capacity Rule

delete

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

capacityRuleIdstringRequired

Responses

204

OK

404

Workspace or Capacity Rule not found

application/json

delete

/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Assign Capacity Rule

post

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

capacityRuleIdstringRequired

Body

application/json

agentsstring · uuid[]Required

Responses

204

Assigned a Capacity Rule.

404

Workspace or Capacity Rule not found

application/json

422

Invalid input

application/json

post

/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "agents": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

No content

get agents assigned to Capacity Rule

get

Authorizations

useraccessKey

AuthorizationstringRequired

Provide the token that is returned upon login

Path parameters

workspaceIdstringRequired

capacityRuleIdstringRequired

Responses

200

Successful operation

application/json

get

/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful operation

{
  "agents": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}