Managers

Updated at January 7th, 2025

+ More

The MANAGERS APIs category relates to activities involving the Admins, Team Leaders, Agents, and any other business-related persona. This category includes Profiles, Presence, Assignments, Notifications, and Teams sub-categories.

GET: Get Manager Status

Based on the agent’s Id, this API returns information about the current number of assignments based on the different statuses.

Required parameter is the Manager Id (agent/admin Id number generated by Cirrus)
API returns the Agent’s current assignments tally.

https://api.Cirrus.io/managers/{MANAGER_ID}/stats

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

object

id	integer The agent's Id number
AsyncAssignedNoResponse	integer Current number of assigned asynchronous conversations (objects) awaiting a response
AsyncAssignedInProccess	integer Current number of assigned asynchronous conversations (objects) that are being addressed by the manager
SyncAssignedNoResponse	integer Current number of assigned synchronous conversations (objects) awaiting a response
SyncAssignedInProccess	integer Current number of assigned synchronous conversations (objects) that are being addressed by the manager
FaceToFaceStatus	boolean Returns true if the agent is busy with a face-to-face conversation (Voice/Video call)
TotalAsyncAssigned	integer Total number of currently assigned Asynchronous conversations.
TotalSyncAssigned	integer Total number of currently assigned Synchronous conversations.

GET: Get Manager

This API returns information about a specific agent or an administrator based on the manager Id (required).

https://api.commbox.io/managers/{MANAGER_ID}

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

object

id	integer The manager’s id number
content	string Lists related statuses about the agent/admin: Active state – shows the user’s status, Password verification, Email verification, Chosen color
identityId	integer Cirrus associates conversations with a customer via a specified communication channel. A customer may have a few identities when the conversation is using more than one communication channel. For agents/admins, this number is irrelevant and just identifies the user as a Manager.
streamProviderId	string Access point – usually the email
thumbnailUrl	string If the agent/admin has an associated thumbnail picture, the URL to the file will be listed here.
brandId	integer The Cirrus account number associated with this agent/admin
permissionId	integer Admins will have 3. Agents may have any other number (usually 2)
firstName	string
lastName	string
email	string
userName	string
teamId	integer Lists the teams’ Id associated with the agent/admin
teamName	string
profiles	string List profiles Id associated with the agent/admin
maxSyncObjectsAssignments	integer States the maximum number of Synchronous conversations the agent allows to have (Admins or agents without limitations will be null). Edit in the Auto Assignment module or in the Status tab of the Users page.
maxAsyncObjectsAssignments	integer States the maximum number of Asynchronous conversations the agent allows to have (Admins or agents without limitations will be null). Edit in the Auto Assignment module or in the Status tab of the Users page.
multiReplyAccess	string Related to profiles

POST: Update Manager

path Parameters

MANAGER_ID
required

integer <int64>

Manager ID. This is a Cirrus generated number

Request Body schema: application/json

required

Optional description for new mail object in Markdown

Id	integer <int64> Manager ID. This is a Cirrus generated number and used throughout all the updates
AsyncAssignedNoResponse	integer Current number of assigned asynchronous objects awaiting response
AsyncAssignedInProccess	integer Current number of assigned asynchronous objects that are being addressed by the manager
SyncAssignedNoResponse	integer Current number of assigned synchronous objects awaiting response (Chat/messenger conversations)
SyncAssignedInProccess	integer Current number of assigned synchronous objects that are being addressed by the manager (Chat/messenger conversations)
FaceToFaceStatus	boolean Returns true if the agent is busy with a face to face conversation (Voice/Video call)
TotalAsyncAssigned	integer Total number of currently assigned objects
TotalSyncAssigned	integer Total number of currently assigned synchronous objects (Chat/messenger conversations)

Response Schema: application/json

status

string

description

string

response_time

string

object

integer

DEL: Delete Manager

This API deletes agents/admins from the system based on their Agent/Admin Id (Manager_Id).

DELETE/managers/{manager_ID}

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

object

integer

GET: Get Managers

This API returns a list of all agents and admins related to the account.
It sends a URL (The specific account Id will be the authentication params) and returns a list of agents/admin found in the account.

GET/managers

Response Schema: application/json

status

string

description

string

response_time

string

Array of objects or objects

Array

One of

id	integer The agent’s or admin’s Id number
identityId	integer Cirrus associates conversations with a customer via a specified communication channel. A customer may have a few identities when the conversations use more than one communication channel. For agents/admins, this number is irrelevant and just identifies the user as a manager.
streamProviderId	string Access point – usually the email
thumbnailUrl	string If the agent/admin has an associated thumbnail picture, the URL to the file will be listed here.
brandId	integer The business account number in Cirrus
permissionId	integer
firstName	string
lastName	string
email	string
userName	string
team	integer List all teams associated with this agents
teamId	integer Id of the first team this agent belonged to
teamName	string The name of the first listed team
profiles	string Profiles Id(s) associated with this agent.
maxSyncObjectsAssignments	integer
maxAsyncObjectsAssignments	integer

POST: Create Manager

This API creates a new agent or an admin in the system.
Required parameters include the full name, email address, and initial password.

Body params must also include if the new entity is an admin (IsAdmin Boolean is true) or an agent (IsAdmin Boolean is false).
Add the team Id and profile Id for the new agent (optional).

API returns a user Id.

Request Body schema: application/json

required

Optional description for new mail object in Markdown

Id	integer <int64> Manager ID. This is a cirrus generated number and used throughout all the updates
AsyncAssignedNoResponse	integer Current number of assigned asynchronous objects awaiting response
AsyncAssignedInProccess	integer Current number of assigned asynchronous objects that are being addressed by the manager
SyncAssignedNoResponse	integer Current number of assigned synchronous objects awaiting response (Chat/messenger conversations)
SyncAssignedInProccess	integer Current number of assigned synchronous objects that are being addressed by the manager (Chat/messenger conversations)
FaceToFaceStatus	boolean Returns true if the agent is busy with a face to face conversation (Voice/Video call)
TotalAsyncAssigned	integer Total number of currently assigned objects
TotalSyncAssigned	integer Total number of currently assigned synchronous objects (Chat/messenger conversations)

Response Schema: application/json

status

string

description

string

response_time

string

object

integer

Contact Us

Managers

Contact Us

GET: Get Manager Status

path Parameters

Response Schema: application/json

GET: Get Manager

path Parameters

Response Schema: application/json

POST: Update Manager

path Parameters

Request Body schema: application/json

Response Schema: application/json

DEL: Delete Manager

path Parameters

Response Schema: application/json

GET: Get Managers

Response Schema: application/json

POST: Create Manager

Request Body schema: application/json

Response Schema: application/json

Related Articles