Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Knowledge Bases

Create knowledge base category in specified locale

Creates a knowledge base category for a given locale.

Required scope: knowledge_bases:write

post/knowledge_bases/{knowledge_base_id}/locales/{locale}/categories

Path parameters

knowledge_base_idstring required

The ID of the knowledge base to create the category in

localestring required

The locale of the category's content

Request body

parent_category_idstring

ID of the parent category

namestring required

Name of the knowledge base category

descriptionstring

Description of the knowledge base category

Response

A knowledge base category with content

idstring required

Unique identifier of the knowledge base category

namestring nullable required

Category name

descriptionstring nullable required

Description of the category

is_hiddenboolean required

Is the category hidden

locale'fr' | 'en' required

Locale of this category

created_atnumber

Timestamp when the category was created

updated_atnumber

Timestamp when the category was updated

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/knowledge_base_categories/kbc_12",
    "related": {
      "knowledge_base": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12",
      "parent_category": "https://yourCompany.api.frontapp.com/knowledge_base_catgories/kbc_10",
      "articles": "https://yourCompany.api.frontapp.com/knowledge_base_categories/kbc_12/articles"
    }
  },
  "id": "kbc_12",
  "name": "Getting started",
  "description": "How to get started in Front",
  "locale": "en",
  "created_at": 1622672452.363,
  "updated_at": 1654309308.278
}