KB User's Guide - API - Setting Featured Articles via the KB Admin Tools

This document explains how to set a list of featured articles to be called via the Featured Articles API.

One of the KB's API services allows for the calling of a custom list of articles, which can be displayed as desired anywhere the API is being consumed. While it is possible to control the articles included in the list via the API, you can also set this within the KB Admin Tools. This may be desirable in cases where you wish to set up the API call once and more easily update the list of articles.

For more information on the Featured Articles API, including an alternative means of specifying the articles displayed, please see: KB User's Guide - API - Featured Articles.

  1. Log into the KB Admin Tools and go to the SitePref tab > Content Modules.

  2. In the form to Add a new custom content module, do the following:

    • Enter a name for your module (this won't be displayed in the API)
    • Make sure the module is checked for "External"
    • Set the Order to "-1"
    • Enter a comma-delimited list of document IDs in the DocID(s) / URL field

    1-featured-articles.png
  3. Click Add to save the content module.




Keywords:custom selected documents apis adding removing updating creating   Doc ID:75345
Owner:Leah S.Group:KB User's Guide
Created:2017-08-07 17:25 CDTUpdated:2017-08-07 17:28 CDT
Sites:KB User's Guide
Feedback:  0   0