Sign in
latestOpenAPI 3.0.32026-08-20147323331.7 KB

a7231589e927

articles

Update an article

Updates an existing article. Only provided fields are modified.

Rate limit: 20 requests per minute

patch/knowledge-bases/{id}/articles/{article_id}

Path parameters

idstring required

The KnowledgeBaseID of the article to update.

article_idstring required

The ID of the article to update.

Request body

body_htmlstring

The HTML body of the article.

is_publishedboolean

Whether the article should be published or unpublished.

is_unlistedboolean

Whether the article is accessible only via a direct link.

languagestring

The language code of the translation to update. If not provided, the default language (original article) will be updated.

publish_updated_body_htmlboolean

Whether the changes to the article should be published. Defaults to false.

tag_idsstring[]

IDs of article tags to assign. If provided, replaces all tags currently assigned to the article.

titlestring

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"
          }
        ]
      }
    }
  }
}