Capacity Rules

List capacity rules

Retrieve list of capacity rule

GET/workspaces/{workspaceId}/inbox/capacity

Authorization

useraccessKey

Path parameters

workspaceId*string

Query parameters

Response

200

OK

Body

application/json

results*array of CapacityRule (object)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/capacity', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

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

Create Capacity Rule

POST/workspaces/{workspaceId}/inbox/capacity

Authorization

useraccessKey

Path parameters

workspaceId*string

Body

application/json

name*string

description*string

defaultboolean

capacity*object

agentsarray of string (uuid)

Response

201409422

Created a Capacity Rule.

Body

application/json

id*string

workspaceId*string

name*string

description*string

defaultboolean

capacity*object

assignedAgentIdsnullable array of string (uuid)

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/capacity', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "description": "text",
      "capacity": {
        "messaging": 0,
        "email": 0
      }
    }),
});
const data = await response.json();

Response

201409422

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

Get a Capacity Rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

capacityRuleId*string

Response

200404

ok

Body

application/json

id*string

workspaceId*string

name*string

description*string

defaultboolean

capacity*object

assignedAgentIdsnullable array of string (uuid)

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

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

Update Capacity Rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

capacityRuleId*string

Body

application/json

namestring

descriptionstring

defaultboolean

capacityobject

Response

200404409422

Updated

Body

application/json

id*string

workspaceId*string

name*string

description*string

defaultboolean

capacity*object

assignedAgentIdsnullable array of string (uuid)

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404409422

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

Delete a Capacity Rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

capacityRuleId*string

Response

204404

OK

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "text"
}

Assign Capacity Rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

capacityRuleId*string

Body

application/json

agents*array of string (uuid)

Response

204404422

Assigned a Capacity Rule.

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "agents": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }),
});
const data = await response.json();

Response

404422

{
  "code": "text",
  "message": "text"
}

get agents assigned to Capacity Rule

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

Authorization

useraccessKey

Path parameters

workspaceId*string

capacityRuleId*string

Response

200

Successful operation

Body

application/json

agentsarray of string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('/workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200

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