1. API
  2. v1
  3. CORE
  4. CASES

Tags

Resource Fields

Name Type Read-only Description
name string



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve all tags

GET /api/v1/cases/:id/tags.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations
Ordered by created_at (ascending)

Response

{
    "status": 200,
    "data": [
        {
            "id": 1,
            "name": "important",
            "resource_type": "tag"
        }
    ],
    "resource": "tag",
    "total_count": 1
}

Add tags

POST /api/v1/cases/:id/tags.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations

Parameters

Name Type Mandatory Description
tags string
Comma separated tags

Response

{
    "status": 201,
    "data": [
        {
            "id": 1,
            "name": "important",
            "resource_type": "tag"
        }
    ],
    "resource": "tag",
    "total_count": 1
}

Replace tags

PUT /api/v1/cases/:id/tags.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations

Parameters

Name Type Mandatory Description
tags string
Comma separated tags

Response

{
    "status": 200,
    "data": [
        {
            "id": 1,
            "name": "important",
            "resource_type": "tag"
        }
    ],
    "resource": "tag",
    "total_count": 1
}

Remove tags

DELETE /api/v1/cases/:id/tags.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations

Arguments

Name Type Mandatory Description
tags string
Comma separated tags

Response

{
    "status": 200,
    "data": [
        {
            "id": 1,
            "name": "important",
            "resource_type": "tag"
        }
    ],
    "resource": "tag",
    "total_count": 1
}