Assignments
Updated at January 20th, 2025
The Assignments category relates to conversations (Objects) assigned to a specific agent.
GET: Get Manager Assignments
This API returns a list of assigned conversations to a specific agent/admin.
Manager (agent) Id is a required path parameter.
Data includes the communication channel type (see Enum) and its unique name.
GET/managers/{manager_id}/assignments
path Parameters
|
MANAGER_ID required
|
integer <int64>
Manager ID. This is a Cirrus generated number |
Response Schema: application/json
| status | string
|
||||||||
| description | string
|
||||||||
| response_time | string
|
||||||||
Array of objects or objects or objects
|
|||||||||
Array
One of
| |||||||||
POST: Assign Manager
This API assigns a conversation to a specific agent.
Manager (agent) Id is a required path parameter, and the Object (conversation) Id is a required query parameter.
Example
https://api.commbox.io/managers/{MANAGER_ID}/assignments?objectId={OBJECT_ID}
path Parameters
|
MANAGER_ID required
|
integer <int64>
Valid MANAGER_ID |
query Parameters
|
objectId required
|
integer <int64>
objectId |
Response Schema: application/json
| status | string
|
| description | string
|
| response_time | string
|
| data | string |
DEL: Unassign Manager
This API unassigns a conversation to a specific agent.
Manager (agent)Id is a required path parameter, and the Object (conversation) Id is a required query parameter.
DELETE/managers/{MANAGER_ID}/assignments
Example
https://api.commbox.io/managers/{MANAGER_ID}/assignments?objectId={OBJECT_ID}
path Parameters
|
MANAGER_ID required
|
integer <int64>
Valid MANAGER_ID |
query Parameters
|
objectId required
|
integer <int64>
objectId |
Response Schema: application/json
| status | string
|
| description | string
|
| response_time | string
|
| data | string |
