No-code docs

Capacity Rules

List capacity rules

get

Retrieve list of capacity rule

Authorizations
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
GET /workspaces/{workspaceId}/inbox/capacity HTTP/1.1
Host: 
Authorization: Bearer jwt
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
Path parameters
workspaceIdstringRequired
Body
namestring · min: 1 · max: 255Required
descriptionstring · min: 1 · max: 255Required
defaultbooleanOptional
agentsstring · uuid[]Optional
Responses
201
Created a Capacity Rule.
application/json
post
POST /workspaces/{workspaceId}/inbox/capacity HTTP/1.1
Host: 
Authorization: Bearer jwt
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
Path parameters
workspaceIdstringRequired
capacityRuleIdstringRequired
Responses
200
ok
application/json
get
GET /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId} HTTP/1.1
Host: 
Authorization: Bearer jwt
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
Path parameters
workspaceIdstringRequired
capacityRuleIdstringRequired
Body
namestringOptional
descriptionstringOptional
defaultbooleanOptional
Responses
200
Updated
application/json
patch
PATCH /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId} HTTP/1.1
Host: 
Authorization: Bearer jwt
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
Path parameters
workspaceIdstringRequired
capacityRuleIdstringRequired
Responses
204
OK
delete
DELETE /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Assign Capacity Rule

post
Authorizations
Path parameters
workspaceIdstringRequired
capacityRuleIdstringRequired
Body
agentsstring · uuid[]Required
Responses
204
Assigned a Capacity Rule.
post
POST /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 51

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

get agents assigned to Capacity Rule

get
Authorizations
Path parameters
workspaceIdstringRequired
capacityRuleIdstringRequired
Responses
200
Successful operation
application/json
get
GET /workspaces/{workspaceId}/inbox/capacity/{capacityRuleId}/agents HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*
200

Successful operation

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

Last updated

Was this helpful?