---
title: "Update an article"
method: PATCH
path: "/knowledge-bases/{id}/articles/{article_id}"
tags: ["articles"]
---

# Update an article

`PATCH /knowledge-bases/{id}/articles/{article_id}`

Updates an existing article. Only provided fields are modified.

**Rate limit:** 20 requests per minute

## Path parameters

- `id` string, required
- `article_id` string, required

## Request body

- UpdateArticleRequestBody
  - `body_html` string — The HTML body of the article.
  - `is_published` boolean — Whether the article should be published or unpublished.
  - `is_unlisted` boolean — Whether the article can only be accessible only via direct link.
  - `language` string — The language code of the translation to update. If not provided, the default language (original article) will be updated.
  - `publish_updated_body_html` boolean — Whether the changes to the article should be published. Defaults to false.
  - `tag_ids` string[] — IDs of article tags to assign. If provided, replaces all tags currently assigned to the article.
  - `title` string — The title of the article.
  - `visibility_config` ArticleVisibilityConfig
    - `ai_agent_access` 'inherit' | 'none' | 'specific_agents' — AI agent access control. Defaults to inherit from the parent scope when omitted. `inherit`: Defers the access check to the parent object (Collection or KnowledgeBase). `none`: No AI agents have access to this article. `specific_agents`: Only specific AI agents enumerated in the allowlist have access.
    - `allowed_agent_ids` string[] — List of AI agent IDs that may access this resource when ai_agent_access is set to "specific_agents".
    - `customer_visibility_condition` Filter
      - `field` string, required — The field for this filter. For allowed fields, see the documentation for the specific endpoint you are using. For non-compound filters (any operators other than "and" or "or"), Field must be set, along with either Value or Values, depending on the operator.
      - `operator` 'equals' | 'not_equals' | 'contains' | 'does_not_contain' | 'in' | 'not_in' | 'and' | 'or' | 'time_is_after' | 'time_is_before' | 'time_range' | 'string_contains' | 'string_does_not_contain' | 'is_set' | 'is_unset' | 'greater_than' | 'less_than' | 'greater_than_or_equals' | 'less_than_or_equals', required — The operator for this filter. `equals`: Matches objects that are exactly equal to the value in the field. `not_equals`: Matches objects that are not exactly equal to the value in the field. `contains`: For a multi-valued field, such as tags, this operator will match objects that contain any of the values in the field. `does_not_contain`: For a multi-valued field, such as tags, this operator will match objects that do not contain any of the values in the field. `in`: Matches objects if the field is one of several possible values, as specified in the values array. `not_in`: Matches objects if the field is none of several possible values, as specified in the values array. `and`: Matches objects only if all subfilters match. `or`: Matches objects if any subfilter matches. `time_is_after`: Matches objects if the field is after the given time. `time_is_before`: Matches objects if the field is before the given time. `time_range`: Matches objects if the field is between the given times. `string_contains`: Matches objects if the field contains the given string. `string_does_not_contain`: Matches objects if the field does not contain the given string. `is_set`: Matches objects if the field is set. `is_unset`: Matches objects if the field is unset. `greater_than`: Matches objects if the numeric field is greater than the given value. `less_than`: Matches objects if the numeric field is less than the given value. `greater_than_or_equals`: Matches objects if the numeric field is greater than or equal to the given value. `less_than_or_equals`: Matches objects if the numeric field is less than or equal to the given value.
      - `subfilters` Filter[] — Sub-filters for this filter. Valid only when operator is "and" or "or". The maximum allowed depth for a tree of filters is 3.
      - `value` string — The value for this filter. Only used for single-valued operators ("equals", "not_equals", "contains", "does_not_contain")
      - `values` string[] — The values for this filter. Only used for multi-valued operators ("in", "not_in").
    - `visibility` 'public' | 'customer' | 'internal_only' — The visibility setting.

## Response `200`

- UpdateArticleResponseBody
  - `data` Article
    - `approval_info` ArticleApprovalInfo
      - `requested_at` string — The time a review was requested. Null if no review has been requested.
      - `reviewed_at` string — The time the current review decision was made. Null if no review decision has been made.
      - `reviewed_by_user_id` string — The ID of the user who made the current review decision. Null if no review decision has been made.
      - `status` string — The approval status. Possible values: needs_review, changes_requested, approved.
    - `author_user_id` string — The ID of the user who authored the article.
    - `collection_id` string — The ID of the collection this article belongs to, if any.
    - `created_at` string — The time the article was created.
    - `current_draft_content_html` string — The current draft content of the article in HTML. This is the latest version, which may differ from the published version.
    - `current_published_content_html` string — The current published content of the article in HTML.
    - `id` string — The ID of the article.
    - `identifier` string — The identifier of the article
    - `is_published` boolean — IsPublished indicates if the article is published.
    - `is_unlisted` boolean — Whether the article can only be accessible only via direct link.
    - `last_edited_at` string — The time the article content was last edited.
    - `last_published_at` string — The last published at time of the article.
    - `slug` string — The slug of the article.
    - `tags` Tag[] — Tags assigned to the article.
      - `hex_color` string — The hex code of the tag's color.
      - `id` string — The ID of the tag.
      - `object_type` string — The object type of the tagged object.
      - `value` string — The value of the Tag.
    - `title` string — The name of the article.
    - `url` string — The URL of the article.
    - `visibility_config` ArticleVisibilityConfig
      - `ai_agent_access` 'inherit' | 'none' | 'specific_agents' — AI agent access control. Defaults to inherit from the parent scope when omitted. `inherit`: Defers the access check to the parent object (Collection or KnowledgeBase). `none`: No AI agents have access to this article. `specific_agents`: Only specific AI agents enumerated in the allowlist have access.
      - `allowed_agent_ids` string[] — List of AI agent IDs that may access this resource when ai_agent_access is set to "specific_agents".
      - `customer_visibility_condition` Filter
        - `field` string, required — The field for this filter. For allowed fields, see the documentation for the specific endpoint you are using. For non-compound filters (any operators other than "and" or "or"), Field must be set, along with either Value or Values, depending on the operator.
        - `operator` 'equals' | 'not_equals' | 'contains' | 'does_not_contain' | 'in' | 'not_in' | 'and' | 'or' | 'time_is_after' | 'time_is_before' | 'time_range' | 'string_contains' | 'string_does_not_contain' | 'is_set' | 'is_unset' | 'greater_than' | 'less_than' | 'greater_than_or_equals' | 'less_than_or_equals', required — The operator for this filter. `equals`: Matches objects that are exactly equal to the value in the field. `not_equals`: Matches objects that are not exactly equal to the value in the field. `contains`: For a multi-valued field, such as tags, this operator will match objects that contain any of the values in the field. `does_not_contain`: For a multi-valued field, such as tags, this operator will match objects that do not contain any of the values in the field. `in`: Matches objects if the field is one of several possible values, as specified in the values array. `not_in`: Matches objects if the field is none of several possible values, as specified in the values array. `and`: Matches objects only if all subfilters match. `or`: Matches objects if any subfilter matches. `time_is_after`: Matches objects if the field is after the given time. `time_is_before`: Matches objects if the field is before the given time. `time_range`: Matches objects if the field is between the given times. `string_contains`: Matches objects if the field contains the given string. `string_does_not_contain`: Matches objects if the field does not contain the given string. `is_set`: Matches objects if the field is set. `is_unset`: Matches objects if the field is unset. `greater_than`: Matches objects if the numeric field is greater than the given value. `less_than`: Matches objects if the numeric field is less than the given value. `greater_than_or_equals`: Matches objects if the numeric field is greater than or equal to the given value. `less_than_or_equals`: Matches objects if the numeric field is less than or equal to the given value.
        - `subfilters` Filter[] — Sub-filters for this filter. Valid only when operator is "and" or "or". The maximum allowed depth for a tree of filters is 3.
        - `value` string — The value for this filter. Only used for single-valued operators ("equals", "not_equals", "contains", "does_not_contain")
        - `values` string[] — The values for this filter. Only used for multi-valued operators ("in", "not_in").
      - `visibility` 'public' | 'customer' | 'internal_only' — The visibility setting.
  - `request_id` string — The request ID for tracking.

## Other responses

- `400` — The request was invalid or could not be completed.
- `404`
- `500` — An unexpected internal error occurred.

---

[API](https://skmtc.net/usepylon/apis/pylon-api.md) · [All operations](https://skmtc.net/usepylon/apis/pylon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usepylon/pylon-api/versions/7b6ea6af992a/schema)