---
  1. API
  2. v1
  3. CHANNELS
  4. HELP CENTER

Templates

Resource Fields

Name Type Read-only Description
name string
app string
category string
contents string
is_custom boolean



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve templates

GET /api/v1/brands/:id/templates.json

Information

Allowed for Admins & Owners
Scope configuration

Response

    {
        "status": 200,
        "data": [
            {
    "name": "helpcenter_main",
    "app": "HelpCenter",
    "category": "main",
    "contents": "<html><a>header</a> ......",
    "is_custom": false,
    "resource_type": "template",
    "resource_url": "https://brewfictus.kayako.com/api/v1/brands/1/templates/helpcenter_main"
}
        ],
        "resource": "template",
        "offset": 0,
        "limit": 10,
        "total_count": 1
    }

Retrieve a template

GET /api/v1/brands/:id/templates/:name.json

Information

Allowed for Admins & Owners
Scope configuration

Response

    {
        "status": 200,
        "data": {
    "name": "helpcenter_main",
    "app": "HelpCenter",
    "category": "main",
    "contents": "<html><a>header</a> ......",
    "is_custom": false,
    "resource_type": "template",
    "resource_url": "https://brewfictus.kayako.com/api/v1/brands/1/templates/helpcenter_main"
},
        "resource": "template"
    }

Update a template

PUT /api/v1/brands/:id/templates/:name.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
contents string

Response

    {
        "status": 200,
        "data": {
    "name": "helpcenter_main",
    "app": "HelpCenter",
    "category": "main",
    "contents": "<html><a>header</a> ......",
    "is_custom": false,
    "resource_type": "template",
    "resource_url": "https://brewfictus.kayako.com/api/v1/brands/1/templates/helpcenter_main"
},
        "resource": "template"
    }

Restore a template

PUT /api/v1/brands/:id/templates/:name/restore.json

Information

Allowed for Admins & Owners
Scope configuration

Parameters

Name Type Mandatory Description
version_id int To restore to a specific version, pass the id returned from the versions endpoint. If the ID isn't passed, the original (default) template is restored.

Response

    {
        "status": 200,
        "data": {
    "name": "helpcenter_main",
    "app": "HelpCenter",
    "category": "main",
    "contents": "<html><a>header</a> ......",
    "is_custom": false,
    "resource_type": "template",
    "resource_url": "https://brewfictus.kayako.com/api/v1/brands/1/templates/helpcenter_main"
},
        "resource": "template"
    }