Sign in
latestOpenAPI 3.0.32026-08-20147323331.7 KB

a7231589e927

articles

Create an article

Creates a new article within a knowledge base.

Rate limit: 10 requests per minute

post/knowledge-bases/{id}/articles

Path parameters

idstring required

The ID of the knowledge base the article is being added to.

Request body

author_user_idstring required

The ID of the user attributed as the author of the article.

body_htmlstring required

The HTML body of the article.

collection_idstring

The ID of the collection containing the article.

is_publishedboolean

Whether the article should be published. Defaults to false.

is_unlistedboolean

Whether the article is accessible only via a direct link. Defaults to false.

slugstring

The slug of the article. Defaults to a slug based on the title.

titlestring required

The title of the article.

Example request

{
  "visibility_config": {
    "customer_visibility_condition": {
      "subfilters": [
        {
          "field": "state",
          "operator": "equals",
          "value": "new"
        }
      ]
    }
  }
}

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": {
    "tags": [
      {
        "object_type": "issue"
      }
    ],
    "visibility_config": {
      "customer_visibility_condition": {
        "subfilters": [
          {
            "field": "state",
            "operator": "equals",
            "value": "new"
          }
        ]
      }
    }
  }
}