US English (US)
GB English (UK)

By Appointment to
His Majesty The King
Contact Centre Service Software
Cirrus Response Ltd
Epsom

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Cirrus eLearning
  • Contact Us
English (UK)
US English (US)
GB English (UK)
  • Home
  • Cirrus Digital
  • API Documentation
  • API Calls

Tags

Written by Keith Winhall

Updated at January 7th, 2025

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Cirrus Connect
    Agent Supervisor Administrator
  • Cirrus Digital
    Agents Supervisors Administrators API Documentation
  • Release Notes
    Release FAQs Latest Release 2025 2024 2023
  • Customer Billing
+ More

Tags are a classification tool for summarizing aspects of the conversation or the user. It can mark the conversation to indicate a new sale or identify a customer as not interested in the product. To help manage the Tags assets, Tags can be grouped with a common identifier.

POST: Set Object Tag

This API is used to tag a conversation with a specific tag.
Required path parameters included the Stream (channel) Id, Object (conversation) Id, and the desired Tag Id.

(POST) /streams/{STREAM_ID}/objects/{OBJECT_ID}/tags/{TAG_ID}

Example: https://api.wispp.com/streams/17566/objects/372235/tags/2789

path Parameters

STREAM_ID

required
integer <int64>

Stream ID. This is a Cirrus generated number for the channel

OBJECT_ID

required
integer <int64>

Object ID. This is a Cirrus generated number for the conversation

TAG_ID

required
integer <int64>

Tag ID. This is a Cirrus generated number for each tag

Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
data
string
 
 

DEL: Delete Object Tag

This API is used to delete a specific tag from a conversation.
Required path parameters included the Stream (Channel) Id, Object (conversation) Id, and the desired Tag Id.

(DELETE) /streams/{STREAM_ID}/objects/{OBJECT_ID}/tags/{TAG_ID}
Example: https://api.wispp.com/streams/17566/objects/372235/tags/2789

path Parameters

STREAM_ID

required
integer <int64>

Stream ID. This is a Cirrus generated number for the channel

OBJECT_ID

required
integer <int64>

Object ID. This is a Cirrus generated number for the conversation

TAG_ID

required
integer <int64>

Tag ID. This is a Cirrus generated number for each tag

Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
data
string
 
 

GET: Get Tags

This API returns a list of all Tags in the account/brand as recognized by the authentication.
Data includes the tag's Id number, name (identity id), and type (as a code). A listing of Tag types is found in the Enum section in the Getting Started section.

Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
Array of objects or objects
 
Array

One of

 
id
integer
 
identityId
string
 
streamProviderId
string

 

 
 

POST: Create a Tag

This API creates a new tag, where the name/content of the tag is part of the body parameters.
If you want this new tag to be part of a group of tags, you’ll need to place the group Id in the TagGroupId field.

Tags can be attached to a conversation (object), to a specific comment or a reply (child), or to a customer (user). Set the tag’s attachment options in the boolean parameters (true/false)

The API returns Tag Id.

Request Body schema: application/json
required

Optional description for new mail object in Markdown

object
 
Name
string
 
TagGroupId
integer <int64>
 
ObjectTag
boolean
 
UserTag
boolean
 
ChildTag
boolean
Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
object
 
id
string
 
 

POST: Updating a Tag

This API updates/changes the name/content of a tag.
The tag’s Id is required as part of the URL. The actual changes to the tag are part of the Body Params - the new name/content and the associated group (optional).

path Parameters

TAG_ID

required
integer <int64>

Tag ID. This is a commbox generated number

Request Body schema: application/json
required

Optional description for new mail object in Markdown

object
 
Name
string
 
Tag Group Id
integer <int64>
Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
object
 
id
string
 
 

DEL: Delete a Tag

This API deletes a tag.
The tag’s Id is required as part of the URL.
Obtain a list of tags and their Ids with [GET] Get Tags - https://api.commbox.io/tags

path Parameters

TAG_ID

required
integer <int64>

Tag Id is a Cirrus unique identifier.

Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
object
 
id
string
 
 

GET: Get Tags Group

A few tags with similar purposes, or originating teams, can be grouped together by the organization.
This API lists all the Tags Groups in the account. The API does not list the specific tags within each group.

Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
Array of objects or objects
 
Array

One of

 
id
integer
 
name
string
 
brandId
string
 
 

POST: Create Tags Group

A few tags with similar purposes or originating teams can be grouped together by the organization.
This API creates the name of the group of tags and returns a Tags Group Id.

To add tags to this new group, use the Create Tag API or the Update Tag API.

Request Body schema: application/json
required

Optional description for new mail object in Markdown

object
 
Name
string
Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
object
 
id
string
 
 

POST: Update Tags Group

A few tags with similar purposes or originating team can be grouped together by the organization.
This API lets you change the name of such a group of tags.
All the tags associated with the old name of the tags group will now be associated with the new name.

The Tags Group Id is required.
To add a specific tag to the new group, use the Update Tag API (Tag’s Id required).
To delete a specific tag from the new group, use the Delete Tag API (Tag’s Id required).

ath Parameters

TAGS_GROUP_ID

required
integer <int64>

Tags Group Id. is a CommBox unique identifier

Request Body schema: application/json
required

Optional description for new mail object in Markdown

object
 
Name
string
Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
object
 
id
string
 
 

DEL: Delete a Tags Group

This API deletes a Tags Group - Group ID is required.
Use the Get Tags Group API to obtain a list of tags group names and their Id.

Note: Deleting a group of tags will delete all tags included in that group.

path Parameters

TAGS_GROUP_ID

required
integer <int64>

TAGS_GROUP_ID

Response Schema: application/json
status
string
 
description
string
 
response_time
string
 
object
 
id
string
 
 

 

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Core
  • Objects
  • Streams
  • SMS
  • WhatsApp

Cirrus
Office 126
63 St Mary Axe
London, EC3A 8AA
Tel: 0333 103 3333
Email: cm@cirrusconnects.com

Social: twitter linkedin

Privacy Policy

Postal address
Cirrus
PO Box 708
Epsom, KT17 9RA
Tel: 0333 103 3333
Email: support@cirrusconnects.com

© Copyright Cirrus


Knowledge Base Software powered by Helpjuice

Expand