Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Knowledge Bases

Create article in a knowledge base in specified locale

Create an article for a given locale in a knowledge base.

Required scope: knowledge_bases:write

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

Path parameters

knowledge_base_idstring required

The ID of the knowledge base to create the article in

localestring required

The locale of the article's content

Request body

category_idstring

ID of the category this article belongs to

author_idstring

Teammate ID of the article author

subjectstring

Subject of the article

contentstring

HTML content of the article

status'draft' | 'published'

Article status

Response

A knowledge base article with content

idstring required

Unique identifier of the knowledge base article

slugstring required

URL slug of the article. Construct the full URL using the template of protocol/knowledge base domain/locale/slug, such as https://yourDomain.com/en/articles/5

namestring required

Name of the article

statusstring required

Status of the article

keywordsstring[] required

Article keywords

contentstring required

Article HTML content

localestring required

Locale of the article

last_edited_atnumber

Timestamp when the article was last edited

created_atnumber

Timestamp when the article was created

updated_atnumber

Timestamp when the article was updated

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/knowledge_base_articles/kba_12",
    "related": {
      "knowledge_base": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12",
      "category": "https://yourCompany.api.frontapp.com/knowledge_base_category/kbc_12",
      "last_editor": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a"
    }
  },
  "id": "kba_12",
  "slug": "/articles/5",
  "name": "Billing 101",
  "status": "published",
  "content": "<h1>How to process a return</h1><p>To process a return...</p>",
  "locale": "en",
  "attachments": [
    {
      "id": "fil_3q8a7mby",
      "filename": "Andy_Anger_Management_Certificate.png",
      "url": "https://yourCompany.api.frontapp.com/download/fil_3q8a7mby",
      "content_type": "image/png",
      "size": 4405,
      "metadata": {
        "is_inline": true,
        "cid": "526b45586d0e6b1c484afab63d1ef0be"
      }
    }
  ],
  "last_edited_at": 1622672452.363,
  "created_at": 1622672452.363,
  "updated_at": 1654309308.278
}