v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Knowledge Bases

Update knowledge base in default locale

Updates a knowledge base in the default locale. Will republish the knowledge base if the knowledge base is currently published.

Required scope: knowledge_bases:write

patch/knowledge_bases/{knowledge_base_id}/content

Path parameters

knowledge_base_idstring required

The ID of the knowledge base to update

Request body

namestring

Name of the knowledge base

Response

A knowledge base with content

idstring required

Unique identifier of the knowledge base

namestring required

Knowledge base name

status'published' | 'unpublished' required

Status of the KB

type'internal' | 'external' required

Type of the KB

locale'fr' | 'en' required

Locale of this requested KB

created_atnumber

Timestamp when the knowledge base was created

updated_atnumber

Timestamp when the knowledge base was updated

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12",
    "related": {
      "articles": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12/articles",
      "categories": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12/categories"
    }
  },
  "id": "knb_12",
  "name": "Company Help Center",
  "status": "unpublished",
  "type": "internal",
  "locale": "en",
  "created_at": 1622672452.363,
  "updated_at": 1654309308.278
}