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

Types

Resource Fields

Name Type Read-only Description
label string
type string QUESTION, TASK, PROBLEM, INCIDENT, CUSTOM
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated January 13, 2017

Actions

Retrieve all types

GET /api/v1/cases/types.json

Information

Allowed for Public
Scope conversations

Response

    {
        "status": 200,
        "data": [
            {
    "id": 1,

    "label": "Question",
    "type": "QUESTION",
    "created_at": "2015-07-21T10:39:32+05:00",
    "updated_at": "2015-07-21T10:39:32+05:00",

    "resource_type": "case_type"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/cases/types/1"

}

        ],
        "resource": "case_type",
        "total_count": 1
    }

Retrieve a type

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

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "label": "Question",
    "type": "QUESTION",
    "created_at": "2015-07-21T10:39:32+05:00",
    "updated_at": "2015-07-21T10:39:32+05:00",

    "resource_type": "case_type"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/cases/types/1"

}
,
        "resource": "case_type"
    }

Add a type

POST /api/v1/cases/types.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
label string

Response

    {
        "status": 201,
        "data": {
    "id": 1,

    "label": "Question",
    "type": "QUESTION",
    "created_at": "2015-07-21T10:39:32+05:00",
    "updated_at": "2015-07-21T10:39:32+05:00",

    "resource_type": "case_type"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/cases/types/1"

}
,
        "resource": "case_type"
    }

Update a type

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

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
label string

Response

    {
        "status": 200,
        "data": {
    "id": 1,

    "label": "Question",
    "type": "QUESTION",
    "created_at": "2015-07-21T10:39:32+05:00",
    "updated_at": "2015-07-21T10:39:32+05:00",

    "resource_type": "case_type"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/cases/types/1"

}
,
        "resource": "case_type"
    }

Delete a type

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

Information

Allowed for Admins & Owners
Scope configuration

Note: Deleting a type will remove type from conversations, macros

Response

{
    "status": 200
}

Delete types

DELETE /api/v1/cases/types.json

Information

Allowed for Admins & Owners
Scope configuration

Note: Deleting a type will remove type from conversations, macros

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

{
    "status": 200,
    "total_count": 2
}