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

Help Centers

Resource Fields

Name Type Read-only Description
title string
brand Brand
ga_account_id string
display_messenger boolean
primary_color string
font string
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve all help centers

GET /api/v1/helpcenters.json

Information

Allowed for Admins & Owners

Response

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

    "title": "Brewfictus Support",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "ga_account_id": "12345",
    "display_messenger": true,
    "primary_color": "#4eafcb",
    "font": "Source Sans Pro",
    "created_at": "2016-02-21T11:47:58+05:00",
    "updated_at": "2016-02-21T12:04:08+05:00",

    "resource_type": "help_center"

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

}

        ],
        "resource": "help_center",
        "offset": 0,
        "limit": 10,
        "total_count": 1
    }

Retrieve a help center

GET /api/v1/helpcenters/:id.json

Information

Allowed for Admins & Owners

Response

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

    "title": "Brewfictus Support",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "ga_account_id": "12345",
    "display_messenger": true,
    "primary_color": "#4eafcb",
    "font": "Source Sans Pro",
    "created_at": "2016-02-21T11:47:58+05:00",
    "updated_at": "2016-02-21T12:04:08+05:00",

    "resource_type": "help_center"

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

}
,
        "resource": "help_center"
    }

Update help center

PUT /api/v1/helpcenters/:id.json

Information

Allowed for Admins & Owners

Parameters

Name Type Mandatory Description
title string
ga_account_id string
display_messenger boolean
primary_color string
font string

Response

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

    "title": "Brewfictus Support",
    "brand": {
    "id": 1,

    "resource_type": "brand"

}
,
    "ga_account_id": "12345",
    "display_messenger": true,
    "primary_color": "#4eafcb",
    "font": "Source Sans Pro",
    "created_at": "2016-02-21T11:47:58+05:00",
    "updated_at": "2016-02-21T12:04:08+05:00",

    "resource_type": "help_center"

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

}
,
        "resource": "help_center"
    }