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

Priorities

Resource Fields

Name Type Read-only Description
label string
level integer
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated January 13, 2017

Actions

Retrieve all priorities

GET /api/v1/cases/priorities.json

Information

Allowed for Public
Scope conversations

Response

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

    "label": "High",
    "level": 3,
    "created_at": "2015-07-30T06:45:25+05:00",
    "updated_at": "2015-07-30T06:45:25+05:00",

    "resource_type": "case_priority"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/cases/priorities/3"

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

Retrieve a priority

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

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations

Response

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

    "label": "High",
    "level": 3,
    "created_at": "2015-07-30T06:45:25+05:00",
    "updated_at": "2015-07-30T06:45:25+05:00",

    "resource_type": "case_priority"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/cases/priorities/3"

},
        "resource": "case_priority"
    }

Add a priority

POST /api/v1/cases/priorities.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
label string
level integer

Response

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

    "label": "High",
    "level": 3,
    "created_at": "2015-07-30T06:45:25+05:00",
    "updated_at": "2015-07-30T06:45:25+05:00",

    "resource_type": "case_priority"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/cases/priorities/3"

},
        "resource": "case_priority"
    }

Update a priority

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

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
label string
level integer

Response

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

    "label": "High",
    "level": 3,
    "created_at": "2015-07-30T06:45:25+05:00",
    "updated_at": "2015-07-30T06:45:25+05:00",

    "resource_type": "case_priority"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/cases/priorities/3"

},
        "resource": "case_priority"
    }

Reorder priorities

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

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
priority_ids string
Pass the priorities in order you want to set

Response

{
    "status": 200
}

Delete a priority

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

Information

Allowed for Admins & Owners
Scope configuration

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

Response

{
    "status": 200
}

Delete priorities

DELETE /api/v1/cases/priorities.json

Information

Allowed for Admins & Owners
Scope configuration

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

Arguments

Name Type Mandatory Description
ids string
The comma separated ids

Response

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