Teams
Updated at January 16th, 2025
A Team is a group of agents with specific business agendas, roles, and permissions. Admins and Team Managers can set up Team Managers to create and manage teams and give those teams specific inbox filters, tags, and knowledge-based assets.
GET: Get Team Members
This API returns a list of all agents and team leaders associated with a specific team.
Team Id is a required path parameter.
GET/managers/teams/{TEAM_ID}
path Parameters
|
TEAM_ID required
|
integer <int64>
Team ID. This is a Cirrus generated number |
Response Schema: application/json
| status | string
|
||||||||||||||
| description | string
|
||||||||||||||
| response_time | string
|
||||||||||||||
Array of objects or objects
|
|||||||||||||||
Array
One of
| |||||||||||||||
POST: Update Team by Team ID
Update team by given parameters
POST/managers/teams/{TEAM_ID}
path Parameters
|
TEAM_ID required
|
integer <int64>
Team ID. This is a Cirrus generated number |
Response Schema: application/json
| status | string
|
| description | string
|
| response_time | string
|
| data | string |
DEL: Delete a Team
This API deletes a team based on the Team Id (required Parameter).
DELETE/managers/teams/{team_id}
path Parameters
|
TEAM_ID required
|
integer <int64>
Team ID. This is a CIRRUS generated number |
Response Schema: application/json
| status | string
|
| description | string
|
| response_time | string
|
| data | string |
GET: Get All Teams
This API lists all the Teams Ids and their names for the account.
GET/managers/teams
query Parameters
|
Name required
|
string |
Response Schema: application/json
| status | string
|
||||
| description | string
|
||||
| response_time | string
|
||||
Array of objects or objects
|
|||||
Array
One of
| |||||
POST: Create a Team
This API is used to create a new Team.
Enter the new Team’s name in the query parameter.
The API returns a new Team Id number.
POST/managers/teams
query Parameters
|
Name required
|
string |
Response Schema: application/json
| status | string
|
||
| description | string
|
||
| response_time | string
|
||
object
|
|||
| |||
