1. API
  2. v1
  3. OTHER
  4. GENERAL

Settings

Resource Fields

Name Type Read-only Description
category string
name string
is_protected boolean
value string



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve all settings

GET /api/v1/settings.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope configuration

Arguments

Name Type Mandatory Description
category string a name of the category

Response

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

    "category": "account",
    "name": "default_language",
    "is_protected": false,
    "value": "en-us",

    "resource_type": "setting"
  },
  {
    "id": 2,

    "category": "account",
    "name": "timezone",
    "is_protected": false,
    "value": "UTC",

    "resource_type": "setting"
  },
  {
    "id": 3,

    "category": "account",
    "name": "time_format",
    "is_protected": false,
    "value": "24hour",

    "resource_type": "setting"
  }
],
        "resource": "setting",
        "total_count": 3
    }

Update settings

PUT /api/v1/settings.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
values array It accepts a key-value pair to update settings value. Supports multiple updates.

Example:
['general.companyname' => 'Brewfictus',
'general.enablesmtp => 1]

Request

curl -X PUT -k https://brewfictus.kayako.com/api/v1/settings \
-d '{"values":{"general.companyname":"Brewfictus","general.enablesmtp":1}}' \
-H "Content-Type: application/json" \
-u 'jordan.mitchell@brewfictus.com:jmit6#lsXo'

Response

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