Managing or Retrieving Data From the Help Center Using API

Overview

With API, you can manage your Help Center data or content such as retrieving, deleting, or bulk-adding knowledgebase articles, categories, and sections. You can retrieve your content and use the data to transfer them to another Help Center or instance, or from one brand or instance to another. You can also replace your favicon and logo, and even retrieve or update your Help Centers. 

Prerequisites

• To manage or retrieve the Help Center data using API, you will need a user account in Kayako. Depending on the request, you may be required an agent, collaborator, or admin user account.
• Skills and knowledge of API (Application Programming Interface) calls.

Solution

There is not a direct option in the Kayako UI to export articles from the Help Center, bulk add articles. The same is true with deleting a favicon or logo from the Help Center. However, you can use Kayako APIs to perform these actions.

Using an API tool or client (e.g., Postman), you may perform the requests to obtain, delete, or update the required information or data.

1. Launch your API tool or client.
2. Refer to the API documentation for the API call requests to manage the following from your Help Center:
   • Articles
   • Sections
   • Categories
   • Comments
   • Favicon
   • Logo
   • Help Centers
   • Templates

Confirmation

When making an API request, a call may return with a "Status: 200" which is the default code for successful responses. Or a "Status: 201" may be returned which means a resource has been created.

Please refer to our API documentation for the list of  HTTP status codes.