Capacity Rules

List capacity rules

get

Retrieve list of capacity rule

Authorizations

Path parameters

workspaceIdstringrequired

Query parameters

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

Limits the number of results to return

pageTokenstring · max: 8000optional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

OK

Create Capacity Rule

post

Authorizations

Path parameters

workspaceIdstringrequired

Body

namestring · min: 1 · max: 255required

descriptionstring · min: 1 · max: 255required

defaultbooleanoptional

capacityobjectrequired

agentsstring · uuid[]optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/inbox/capacity' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "default": true,
    "capacity": {
      "messaging": 1,
      "email": 1
    },
    "agents": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

201

409

422

201

{
  "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"
}

Created a Capacity Rule.

Get a Capacity Rule

get

Authorizations

Path parameters

workspaceIdstringrequired

capacityRuleIdstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

404

200

{
  "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"
}

ok

Update Capacity Rule

patch

Authorizations

Path parameters

workspaceIdstringrequired

capacityRuleIdstringrequired

Body

namestringoptional

descriptionstringoptional

defaultbooleanoptional

capacityobjectoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "default": true,
    "capacity": {
      "messaging": 1,
      "email": 1
    }
  }'

200

404

409

422

200

{
  "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"
}

Updated

Delete a Capacity Rule

delete

Authorizations

Path parameters

workspaceIdstringrequired

capacityRuleIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}' \
  --header 'Authorization: Bearer jwt'

204

404

204

No body

OK

Assign Capacity Rule

post

Authorizations

Path parameters

workspaceIdstringrequired

capacityRuleIdstringrequired

Body

agentsstring · uuid[]required

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "agents": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

204

404

422

204

No body

Assigned a Capacity Rule.

get agents assigned to Capacity Rule

get

Authorizations

Path parameters

workspaceIdstringrequired

capacityRuleIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents' \
  --header 'Authorization: Bearer jwt'

200

200

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

Successful operation