Create a Tag

Prev Next
Post
/api/v1/livechat/tags.save
Premium tag

Use this endpoint to create an Omnichannel tag. Permission required: manage-livechat-tags

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Body parameters
Example 1
{
  "tagData": {
    "name": "apiTag",
    "description": "testing"
  },
  "tagDepartments": [
    "TEST-DEPT"
  ],
  "_id": "69536b7a6ff48667974be86b"
}
Expand All
object
tagData
object Required
name
string

Enter a name for the tag.

ExampleSupport
description
string

Enter the tag's description.

ExampleTag for support team
tagDepartments
Array of string

Enter the department IDs that can use this tag.

string
Example["68304887113ac52640bc1ca6"]
_id
string

Use this parameter to update an existing tag.

Example69536b596ff48667974be868
Responses
200

OK

New tag created
{
  "name": "apiTag01",
  "description": "testing api endpoint",
  "numDepartments": 1,
  "departments": [
    "TEST-DEPT"
  ],
  "_id": "69536ca06ff48667974be86d",
  "success": true
}
Updated existing tag
{
  "name": "apiTag-updated",
  "description": "testing api endpoint",
  "numDepartments": 1,
  "departments": [
    "TEST-DEPT"
  ],
  "_updatedAt": "2025-12-30T06:06:00.995Z",
  "_id": "69536b7a6ff48667974be86b",
  "success": true
}
object
name
string
description
string
numDepartments
integer
departments
Array of string
string
_id
string
success
boolean
400

Bad Request

Example 1
{
  "success": false,
  "errorType": "invalid-params",
  "error": "must have required property 'tagData'"
}
object
success
boolean
errorType
string
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string