Skip to content

Create knowledge base article

POST/support/knowledge-base

Creates a new knowledge base article with a title, body, and optional category. Published articles are visible to agents for linking to tickets and to customers via the self-service portal.

Request

Request body

Content type application/json (required).

FieldTypeRequiredDescription
titlestringYes

Article title.

Max length: 255

bodystringYes

Full article content (HTML or Markdown accepted).

category_idinteger, nullableNo

ID of a KB category to organise this article.

statusstringNo

Visibility status of the article.

One of: "draft", "published", "archived" · Default: "draft"

Example

{
  "title": "How to reset your password",
  "body": "<p>Navigate to <strong>Account Settings</strong> and click <em>Reset Password</em>.</p>",
  "status": "published"
}

Responses

302 Redirect to article detail after creation

422 Validation error

Example request

curl -X POST "https://{tenant}.faciotech.net/api/v1/support/knowledge-base" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"title": "How to reset your password", "body": "<p>Navigate to <strong>Account Settings</strong> and click <em>Reset Password</em>.</p>", "status": "published"}'
Loading