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

Statuses

Resource Fields

Name Type Read-only Description
label string
type string NEW, OPEN, PENDING, COMPLETED, CLOSED, CUSTOM
sort_order integer
is_sla_active boolean Default: true
is_deleted boolean
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated January 13, 2017

Actions

Retrieve all statuses

GET /api/v1/cases/statuses.json

Information

Allowed for Public
Scope conversations

Response

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

    "label": "New",
    "type": "NEW",
    "sort_order": 1,
    "is_sla_active": true,
    "is_deleted": false,
    "created_at": "2015-07-21T10:39:32+05:00",
    "updated_at": "2015-07-21T10:39:32+05:00",

    "resource_type": "case_status"

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

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

Retrieve a status

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

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations

Response

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

    "label": "New",
    "type": "NEW",
    "sort_order": 1,
    "is_sla_active": true,
    "is_deleted": false,
    "created_at": "2015-07-21T10:39:32+05:00",
    "updated_at": "2015-07-21T10:39:32+05:00",

    "resource_type": "case_status"

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

},
        "resource": "case_status"
    }

Add a status

POST /api/v1/cases/statuses.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
label string
is_sla_active boolean Default: true
sort_order integer

Response

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

    "label": "New",
    "type": "NEW",
    "sort_order": 1,
    "is_sla_active": true,
    "is_deleted": false,
    "created_at": "2015-07-21T10:39:32+05:00",
    "updated_at": "2015-07-21T10:39:32+05:00",

    "resource_type": "case_status"

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

},
        "resource": "case_status"
    }

Update a status

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

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
label string
is_sla_active boolean
sort_order integer

Response

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

    "label": "New",
    "type": "NEW",
    "sort_order": 1,
    "is_sla_active": true,
    "is_deleted": false,
    "created_at": "2015-07-21T10:39:32+05:00",
    "updated_at": "2015-07-21T10:39:32+05:00",

    "resource_type": "case_status"

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

},
        "resource": "case_status"
    }

Reorder statuses

PUT /api/v1/cases/statuses/reorder.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
status_ids string
Pass the custom statuses in order you want to set

Response

{
    "status": 200
}

Delete a status

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

Information

Allowed for Admins & Owners
Scope configuration

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

Response

{
    "status": 200
}

Delete statuses

DELETE /api/v1/cases/statuses.json

Information

Allowed for Admins & Owners
Scope configuration

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

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

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