> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.document360.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Updates settings for the category

## OpenAPI

````json PUT /v2/Categories/{categoryId}/{langCode}/settings
{
  "openapi": "3.0.1",
  "info": {
    "title": "Document360 Customer API",
    "description": "Document360 RESTful APIs let you integrate your documentation with your software — onboard readers, manage articles, automate publishing, and more.\n\nFull reference: [API Documentation](https://apidocs.document360.io/docs).\n\n## Authentication\nEvery request must include your API token in the `api_token` header. Generate tokens in the Document360 portal under **Settings → Knowledge base portal → API tokens**. Tokens are project-scoped and can be revoked at any time. The same token can be passed via the `api_token` query string for situations where headers are not configurable, but the header form is strongly preferred.\n\n## Project context\nMany endpoints implicitly resolve the project from the API token. When an endpoint requires explicit project context, pass the project identifier in the `ProjectId` header.\n\n## Identifiers — how to fetch them\nMost endpoints accept one or more identifiers as path, query, or body parameters. Use the discovery endpoints below to look them up programmatically rather than hard-coding values:\n\n| Identifier | What it is | Where to fetch it |\n| --- | --- | --- |\n| `projectVersionId` (a.k.a. workspaceId) | A workspace/version inside the project — content (articles, categories, languages) lives within one. | `GET /v2/projectversions` — returns all workspaces with their `id`. Required first to discover articles, categories, and languages. |\n| `categoryId` | A category in the category tree. | `GET /v2/projectversions/{projectVersionId}/categories` — returns the full category hierarchy with each category's `id`. |\n| `articleId` | An article inside a category. | `GET /v2/projectversions/{projectVersionId}/articles` — lists all articles in the workspace. Also available inside the categories tree response. |\n| `langCode` | Two-letter / locale code (`en`, `fr`, `de-DE`, `pt-BR`, …) of an article or category translation. | `GET /v2/language/{projectVersionId}` — returns the languages enabled for the workspace, including `code` and `name`. |\n| `versionNumber` | A specific version of an article or category translation. | `GET /v2/articles/{articleId}/{langCode}/versions` for articles, `GET /v2/categories/{categoryId}/{langCode}versions` for categories. |\n| `userId` (team account) | A portal user (team member). | `GET /v2/teams` — lists all team accounts with their `userId`. `GET /v2/teams/{userId}` returns full details for one. |\n| `groupId` (team) | A team account group. | `GET /v2/teams/groups`. |\n| `roleId` | A role assignable to team accounts. | `GET /v2/teams/roles`. |\n| `readerId` | A reader account (used for private docs / reader analytics). | `GET /v2/readers` — supports pagination and `searchEmail` filtering. |\n| `groupId` (reader) | A reader group. | `GET /v2/readers/groups`. |\n\n**Tip:** In the Document360 portal, the article and category IDs are visible in the URL when an item is open in the editor — e.g. `…/docs/<articleId>/edit/<langCode>`. `projectId` and `projectVersionId` are visible in **Settings → API tokens** and **Documentation → Workspaces** respectively.\n\n## Query parameter casing\nV1/V2 query parameters use **snake_case** on the wire (for example `search_email`, `exclude_readers`, `version_number`). The server transparently maps snake_case query keys to the camelCase parameter names you see in this specification, so either casing is accepted, but snake_case is the documented convention for V1/V2.\n\n## Response envelope\nAll responses are wrapped in a consistent envelope:\n\n- `success` (boolean) — `true` when the operation succeeded, `false` otherwise. Always check this before reading the payload.\n- `errors` (array) — populated when `success` is `false`. Each entry has a human-readable `description`.\n- `warnings` / `information` (arrays) — non-fatal advisories returned alongside a successful response.\n- `result` or `data` — the operation's payload (the property name depends on the endpoint).\n\nHTTP status codes follow standard semantics (`200` success, `400` validation/business error, `401` missing or invalid token, `403` plan/permission restriction, `404` not found, `429` rate-limited, `5xx` server error). For non-`200` responses the envelope still applies — inspect `errors[].description` for details.\n\n## Rate limits\nEndpoints are rate-limited per API token per project. When throttled, the server returns `429 Too Many Requests` along with `Retry-After`, `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers. Use exponential backoff with jitter and respect the `Retry-After` header on the response.\n\n## Versioning\nAll routes are prefixed with the API version: `/v1/...` and `/v2/...`. V1 and V2 are stable; V3 is in Beta. New endpoints and fields may be added without notice in V1/V2 — they will never be removed or renamed in a backwards-incompatible way.",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://apihub.document360.io",
      "description": "Document 360 API Hub"
    },
    {
      "url": "https://apihub.us.document360.io",
      "description": "Document360 API Hub - US data center"
    },
    {
      "url": "https://apihub.{private_hosting}.document360.io",
      "description": "Private hosting - Please provide the subdomain name.",
      "variables": {
        "private_hosting": {
          "default": "domain",
          "description": "Sub domain for private hosting"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Articles",
      "description": "Create, read, update, publish, fork, and delete knowledge base articles. Manage article versions, settings, descriptions, workflow status, and bulk operations. Supports both Markdown and WYSIWYG/Block content types."
    },
    {
      "name": "Categories",
      "description": "Manage the category hierarchy that organizes articles. Create, update, reorder, and delete categories; manage category content, settings, workflow status, and bulk operations."
    },
    {
      "name": "Drive",
      "description": "Upload, organize, and manage media files and folders in Drive (used in articles and documentation)."
    },
    {
      "name": "Readers",
      "description": "Manage reader accounts and reader groups for private documentation. Create readers, assign them to groups, and manage access scopes."
    },
    {
      "name": "Teams",
      "description": "Manage team accounts (portal users), team groups, and role assignments within a project."
    },
    {
      "name": "Project",
      "description": "Project-level operations: export and import project documentation as zip archives."
    },
    {
      "name": "ProjectVersions",
      "description": "Manage workspaces (also called project versions) within a project. List, search, fetch settings, and inspect version metadata."
    },
    {
      "name": "Language",
      "description": "Retrieve languages configured for a workspace."
    },
    {
      "name": "Translations",
      "description": "Query article translation status across the configured languages."
    },
    {
      "name": "CustomField",
      "description": "Retrieve custom field definitions configured for the project. Custom field values are written/read via the Article and Category settings endpoints."
    },
    {
      "name": "APIReferences",
      "description": "Import OpenAPI/Swagger specifications into API reference documentation and inspect import logs."
    }
  ],
  "x-tagGroups": [
    {
      "name": "Workspace",
      "tags": [
        "Project",
        "ProjectVersions"
      ]
    },
    {
      "name": "Content",
      "tags": [
        "Articles",
        "Categories"
      ]
    },
    {
      "name": "Media",
      "tags": [
        "Drive"
      ]
    },
    {
      "name": "Access",
      "tags": [
        "Readers",
        "Teams"
      ]
    },
    {
      "name": "Localization",
      "tags": [
        "Language",
        "Translations"
      ]
    },
    {
      "name": "Custom data",
      "tags": [
        "CustomField"
      ]
    }
  ],
  "paths": {
    "/v2/Categories/{categoryId}/{langCode}/settings": {
      "put": {
        "tags": [
          "Categories"
        ],
        "summary": "Updates settings for the category",
        "operationId": "updateCategorySettingsWithLangCode",
        "parameters": [
          {
            "name": "categoryId",
            "in": "path",
            "description": "The ID of the category. Fetch via `GET /v2/projectversions/{projectVersionId}/categories`.",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "de104b39-db97-4509-8d4c-deeac74d448b"
          },
          {
            "name": "langCode",
            "in": "path",
            "description": "Language code of the category translation (for example `en`, `fr`, `de-DE`, `pt-BR`). Use `GET /v2/language/{projectVersionId}` to list the codes enabled for a workspace. Defaults to `en` when omitted.",
            "required": true,
            "schema": {
              "type": "string",
              "default": "en"
            },
            "example": "en"
          }
        ],
        "requestBody": {
          "description": "Partial settings update — only the fields present in the request body are updated.",
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/UpdateArticleSettingsRequest"
                  }
                ]
              },
              "examples": {
                "Non-Empty body is required.": {
                  "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.",
                  "value": {
                    "slug": "updatedslug",
                    "seo_title": "updatedSeoTitle",
                    "description": "This is the description in updating category settings.",
                    "allow_comments": true,
                    "show_table_of_contents": true,
                    "show_published_version_log": null,
                    "tags": [],
                    "status_indicator": 1,
                    "status_indicator_expiry_date": "2024-06-13T14:30:00",
                    "exclude_from_search": true,
                    "exclude_from_ai_search": false,
                    "related_articles": [],
                    "content_type": 0,
                    "is_acknowledgement_enabled": false,
                    "exclude_from_external_search": false,
                    "custom_fields": [
                      {
                        "field_id": "field-definition-id-1",
                        "value": "Updated Category Type"
                      },
                      {
                        "field_id": "field-definition-id-2",
                        "value": 5
                      }
                    ]
                  }
                }
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/UpdateArticleSettingsRequest"
                  }
                ]
              },
              "examples": {
                "Non-Empty body is required.": {
                  "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.",
                  "value": {
                    "slug": "updatedslug",
                    "seo_title": "updatedSeoTitle",
                    "description": "This is the description in updating category settings.",
                    "allow_comments": true,
                    "show_table_of_contents": true,
                    "show_published_version_log": null,
                    "tags": [],
                    "status_indicator": 1,
                    "status_indicator_expiry_date": "2024-06-13T14:30:00",
                    "exclude_from_search": true,
                    "exclude_from_ai_search": false,
                    "related_articles": [],
                    "content_type": 0,
                    "is_acknowledgement_enabled": false,
                    "exclude_from_external_search": false,
                    "custom_fields": [
                      {
                        "field_id": "field-definition-id-1",
                        "value": "Updated Category Type"
                      },
                      {
                        "field_id": "field-definition-id-2",
                        "value": 5
                      }
                    ]
                  }
                }
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/UpdateArticleSettingsRequest"
                  }
                ]
              },
              "examples": {
                "Non-Empty body is required.": {
                  "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.",
                  "value": {
                    "slug": "updatedslug",
                    "seo_title": "updatedSeoTitle",
                    "description": "This is the description in updating category settings.",
                    "allow_comments": true,
                    "show_table_of_contents": true,
                    "show_published_version_log": null,
                    "tags": [],
                    "status_indicator": 1,
                    "status_indicator_expiry_date": "2024-06-13T14:30:00",
                    "exclude_from_search": true,
                    "exclude_from_ai_search": false,
                    "related_articles": [],
                    "content_type": 0,
                    "is_acknowledgement_enabled": false,
                    "exclude_from_external_search": false,
                    "custom_fields": [
                      {
                        "field_id": "field-definition-id-1",
                        "value": "Updated Category Type"
                      },
                      {
                        "field_id": "field-definition-id-2",
                        "value": 5
                      }
                    ]
                  }
                }
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/UpdateArticleSettingsRequest"
                  }
                ]
              },
              "examples": {
                "Non-Empty body is required.": {
                  "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.",
                  "value": {
                    "slug": "updatedslug",
                    "seo_title": "updatedSeoTitle",
                    "description": "This is the description in updating category settings.",
                    "allow_comments": true,
                    "show_table_of_contents": true,
                    "show_published_version_log": null,
                    "tags": [],
                    "status_indicator": 1,
                    "status_indicator_expiry_date": "2024-06-13T14:30:00",
                    "exclude_from_search": true,
                    "exclude_from_ai_search": false,
                    "related_articles": [],
                    "content_type": 0,
                    "is_acknowledgement_enabled": false,
                    "exclude_from_external_search": false,
                    "custom_fields": [
                      {
                        "field_id": "field-definition-id-1",
                        "value": "Updated Category Type"
                      },
                      {
                        "field_id": "field-definition-id-2",
                        "value": 5
                      }
                    ]
                  }
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetCategorySettingsResponse"
                },
                "examples": {
                  "Successfully updated the setings.": {
                    "summary": "This response indicate a category settings has been successfully updated.",
                    "value": {
                      "data": {
                        "slug": "updated-category",
                        "seo_title": "Updated Category",
                        "description": "Updated category settings description",
                        "allow_comments": true,
                        "show_table_of_contents": true,
                        "show_published_version_log": null,
                        "project_show_published_version_log": false,
                        "effective_show_published_version_log": false,
                        "featured_image_url": null,
                        "tags": [
                          "updated",
                          "category"
                        ],
                        "status_indicator": 0,
                        "status_indicator_expiry_date": null,
                        "exclude_from_search": false,
                        "exclude_from_ai_search": false,
                        "exclude_from_external_search": false,
                        "related_articles": [],
                        "content_type": 0,
                        "is_acknowledgement_enabled": false,
                        "custom_fields": [
                          {
                            "field_id": "field-definition-id-1",
                            "name": "Category Type",
                            "type": 0,
                            "value": "Updated Index Page"
                          },
                          {
                            "field_id": "field-definition-id-2",
                            "name": "Display Order",
                            "type": 6,
                            "value": 5
                          }
                        ]
                      },
                      "extension_data": null,
                      "success": true,
                      "errors": [],
                      "warnings": [],
                      "information": [
                        {
                          "extension_data": null,
                          "description": "Category settings updated successfully"
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The request body or query parameters failed validation. Inspect `errors[].description` for the offending fields.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApiBaseResponse"
                },
                "examples": {
                  "Category Not Found.": {
                    "summary": "Kindly verifty the category Id or the langCode, and perform the task again.",
                    "value": {
                      "extension_data": null,
                      "success": false,
                      "errors": [
                        {
                          "extension_data": null,
                          "stack_trace": null,
                          "description": ".Category not found",
                          "error_code": "400",
                          "custom_data": null
                        }
                      ],
                      "warnings": [],
                      "information": []
                    }
                  },
                  "Non-Empty body is required.": {
                    "summary": "This response is due to an empty request body. \\n Kindly make some body parameters to get success response.",
                    "value": {
                      "extension_data": null,
                      "success": false,
                      "errors": [
                        {
                          "extension_data": null,
                          "stack_trace": null,
                          "description": "A non-empty request body is required.",
                          "error_code": "400",
                          "custom_data": null
                        }
                      ],
                      "warnings": [],
                      "information": []
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authentication failed — the `api_token` header is missing, malformed, or has been revoked.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApiBaseResponse"
                }
              }
            }
          },
          "404": {
            "description": "The requested resource was not found, or the supplied identifier does not exist in the project.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApiBaseResponse"
                }
              }
            }
          },
          "429": {
            "description": "Rate limit exceeded for this api_token. Wait for the duration in the `Retry-After` header before retrying.",
            "headers": {
              "Retry-After": {
                "description": "Number of seconds to wait before retrying the request.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "X-RateLimit-Limit": {
                "description": "The maximum number of requests allowed in the current window.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "X-RateLimit-Remaining": {
                "description": "The number of requests remaining in the current window.",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "X-RateLimit-Reset": {
                "description": "Unix timestamp (seconds) at which the current rate-limit window resets.",
                "schema": {
                  "type": "integer",
                  "format": "int64"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerApiBaseResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "api_token": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "UpdateArticleSettingsRequest": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "description": "The slug of the article",
            "nullable": true,
            "readOnly": true
          },
          "seo_title": {
            "type": "string",
            "description": "The SEO title of the article",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "The SEO description of the article",
            "nullable": true
          },
          "allow_comments": {
            "type": "boolean",
            "description": "Enable or disable the commenting on the article. **true** - Commenting will be enabled; **false** - Commenting will be disabled"
          },
          "show_table_of_contents": {
            "type": "boolean",
            "description": "Enable or disable the Table of Contents (TOC) for the article in the knowledge base. **true** - TOC will be enabled; **false** - TOC will be disabled"
          },
          "show_published_version_log": {
            "type": "boolean",
            "description": "Article/page-category override for showing the published version history log (KB site / export PDF). Send `false` to opt out; omit or send `null` to inherit the project default.",
            "nullable": true
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Custom article tags",
            "nullable": true
          },
          "status_indicator": {
            "enum": [
              "none",
              "new",
              "update",
              "custom"
            ],
            "type": "string",
            "allOf": [
              {
                "$ref": "#/components/schemas/ArticleStatusIndicator"
              }
            ],
            "description": "Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom",
            "x-enumNames": [
              "None",
              "New",
              "Update",
              "Custom"
            ],
            "x-enum-varnames": [
              "None",
              "New",
              "Update",
              "Custom"
            ],
            "x-ms-enum": {
              "name": "ArticleStatusIndicator",
              "modelAsString": true
            }
          },
          "status_indicator_expiry_date": {
            "type": "string",
            "description": "The date-time when the public article status is removed",
            "format": "date-time",
            "nullable": true
          },
          "exclude_from_search": {
            "type": "boolean",
            "description": "**true** - The article will not appear in search results in the knowledge base; **false** - The article will appear in search results in the knowledge base"
          },
          "exclude_from_ai_search": {
            "type": "boolean",
            "description": "**true** - The Eddy-AI assistant will not fetch information from this article; **false** - The Eddy-AI assistant will not exclude this article while fetching information"
          },
          "related_articles": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "The list of related article IDs to show in the knowledge base",
            "nullable": true
          },
          "content_type": {
            "enum": [
              "markdown",
              "wysiwyg",
              "block"
            ],
            "type": "string",
            "allOf": [
              {
                "$ref": "#/components/schemas/ArticleContentType"
              }
            ],
            "description": "0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG",
            "x-enumNames": [
              "Markdown",
              "Wysiwyg",
              "Block"
            ],
            "x-enum-varnames": [
              "Markdown",
              "Wysiwyg",
              "Block"
            ],
            "x-ms-enum": {
              "name": "ArticleContentType",
              "modelAsString": true
            }
          },
          "is_acknowledgement_enabled": {
            "type": "boolean"
          },
          "exclude_from_external_search": {
            "type": "boolean",
            "description": "Set this to true to prevent the page from being indexed by external search engines. Document360 will automatically add a robots meta tag and exclude the page from the sitemap it generates."
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomFieldValueRequest"
            },
            "description": "Custom field values to update. Only provided fields will be updated (partial update supported).",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "GetCategorySettingsResponse": {
        "type": "object",
        "properties": {
          "data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CategorySettingsCustomer"
              }
            ],
            "description": "This is to get category settings data",
            "nullable": true
          },
          "extension_data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ExtensionDataObject"
              }
            ],
            "description": "Extension data for customer API response",
            "nullable": true
          },
          "success": {
            "type": "boolean",
            "description": "Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.",
            "readOnly": true
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BaseError"
            },
            "description": "A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.",
            "nullable": true
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BaseWarning"
            },
            "description": "A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.",
            "nullable": true
          },
          "information": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BaseInformation"
            },
            "description": "Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CustomerApiBaseResponse": {
        "type": "object",
        "properties": {
          "extension_data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ExtensionDataObject"
              }
            ],
            "description": "Extension data for customer API response",
            "nullable": true
          },
          "success": {
            "type": "boolean",
            "description": "Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.",
            "readOnly": true
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BaseError"
            },
            "description": "A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.",
            "nullable": true
          },
          "warnings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BaseWarning"
            },
            "description": "A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.",
            "nullable": true
          },
          "information": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BaseInformation"
            },
            "description": "Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ArticleStatusIndicator": {
        "enum": [
          "none",
          "new",
          "update",
          "custom"
        ],
        "type": "string",
        "description": "Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom",
        "x-enumNames": [
          "None",
          "New",
          "Update",
          "Custom"
        ],
        "x-enum-varnames": [
          "None",
          "New",
          "Update",
          "Custom"
        ],
        "x-ms-enum": {
          "name": "ArticleStatusIndicator",
          "modelAsString": true
        }
      },
      "ArticleContentType": {
        "enum": [
          "markdown",
          "wysiwyg",
          "block"
        ],
        "type": "string",
        "description": "0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG",
        "x-enumNames": [
          "Markdown",
          "Wysiwyg",
          "Block"
        ],
        "x-enum-varnames": [
          "Markdown",
          "Wysiwyg",
          "Block"
        ],
        "x-ms-enum": {
          "name": "ArticleContentType",
          "modelAsString": true
        }
      },
      "CustomFieldValueRequest": {
        "type": "object",
        "properties": {
          "field_id": {
            "type": "string",
            "description": "The ID of the custom field definition",
            "nullable": true
          },
          "value": {
            "description": "The value to set for the custom field. Type depends on field type:\r\n- Text/TextArea: string\r\n- Number: int or double\r\n- Boolean: bool\r\n- Date: DateTime (ISO 8601 format)\r\n- Dropdown: string (option ID)\r\n- MultiSelectDropdown: List<string> (array of option IDs)",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Request model for updating a custom field value"
      },
      "CategorySettingsCustomer": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string",
            "description": "The slug of the category",
            "nullable": true,
            "readOnly": true
          },
          "seo_title": {
            "type": "string",
            "description": "SEO title of the category",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "SEO description of the category",
            "nullable": true
          },
          "allow_comments": {
            "type": "boolean",
            "description": "Allow comments for category"
          },
          "show_table_of_contents": {
            "type": "boolean",
            "description": "`True` - Table of Contents will be enabled \r\n`False` - Table of Contents will be disabled"
          },
          "show_published_version_log": {
            "type": "boolean",
            "description": "Whether the published version history log is shown for this page category (KB site / export PDF). On read this is always a concrete boolean — the category-level override when set, otherwise the effective resolved value. To change it, send `show_published_version_log` on the update-settings request (`false` to opt out, `null`/omit to inherit the project default).",
            "nullable": true
          },
          "project_show_published_version_log": {
            "type": "boolean",
            "description": "Read-only. Project-level default for showing the published version history log."
          },
          "effective_show_published_version_log": {
            "type": "boolean",
            "description": "Read-only. Effective (resolved) visibility = project default AND (category override ?? true)."
          },
          "featured_image_url": {
            "type": "string",
            "description": "URL of the featured image",
            "nullable": true
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of Tags associated to the category",
            "nullable": true
          },
          "status_indicator": {
            "enum": [
              "none",
              "new",
              "update",
              "custom"
            ],
            "type": "string",
            "allOf": [
              {
                "$ref": "#/components/schemas/ArticleStatusIndicator"
              }
            ],
            "description": "Category status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom",
            "x-enumNames": [
              "None",
              "New",
              "Update",
              "Custom"
            ],
            "x-enum-varnames": [
              "None",
              "New",
              "Update",
              "Custom"
            ],
            "x-ms-enum": {
              "name": "ArticleStatusIndicator",
              "modelAsString": true
            }
          },
          "status_indicator_expiry_date": {
            "type": "string",
            "description": "The number of days after which the article status will be removed",
            "format": "date-time",
            "nullable": true
          },
          "exclude_from_search": {
            "type": "boolean",
            "description": "**true** - The caetgory will not appear in search results in the knowledge base\r\n**false** - The category will appear in search results in the knowledge base"
          },
          "exclude_from_ai_search": {
            "type": "boolean",
            "description": "**true** - The AI search assistant will not fetch information from this page category; \r\n**false** - The AI search assistant will not exclude this page category while fetching information"
          },
          "exclude_from_external_search": {
            "type": "boolean"
          },
          "related_articles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RelatedArticleData"
            },
            "description": "The list of related article IDs to show in the knowledge base",
            "nullable": true
          },
          "content_type": {
            "enum": [
              "markdown",
              "wysiwyg",
              "block"
            ],
            "type": "string",
            "allOf": [
              {
                "$ref": "#/components/schemas/ArticleContentType"
              }
            ],
            "description": "0 - Markdown content; 1 - HTML content",
            "x-enumNames": [
              "Markdown",
              "Wysiwyg",
              "Block"
            ],
            "x-enum-varnames": [
              "Markdown",
              "Wysiwyg",
              "Block"
            ],
            "x-ms-enum": {
              "name": "ArticleContentType",
              "modelAsString": true
            }
          },
          "is_acknowledgement_enabled": {
            "type": "boolean"
          },
          "custom_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomFieldValueResponse"
            },
            "description": "Custom field values associated with the category",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Per-category settings — slug, SEO metadata, status indicator, custom fields, and other publishing-time controls. Returned by `GET /v2/categories/{categoryId}/{langCode}/settings`."
      },
      "ExtensionDataObject": {
        "type": "object",
        "additionalProperties": false
      },
      "BaseError": {
        "type": "object",
        "properties": {
          "extension_data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ExtensionDataObject"
              }
            ],
            "description": "This is the Extension data object",
            "nullable": true
          },
          "stack_trace": {
            "type": "string",
            "description": "A technical trace showing where the error occurred within the system. Intended for backend debugging.",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "A clear message explaining what caused the error. This helps quickly understand what went wrong.",
            "nullable": true
          },
          "error_code": {
            "type": "string",
            "description": "A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.",
            "nullable": true
          },
          "custom_data": {
            "type": "object",
            "additionalProperties": {},
            "description": "Any structured metadata for the error object.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array."
      },
      "BaseWarning": {
        "type": "object",
        "properties": {
          "extension_data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ExtensionDataObject"
              }
            ],
            "description": "Extension Data for customer Api warning",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "A plain message that describes the warning and helps understand what should be reviewed.",
            "nullable": true
          },
          "warning_code": {
            "type": "string",
            "description": "A short, predefined code that uniquely identifies the warning type.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "One non-fatal warning attached to an otherwise-successful response."
      },
      "BaseInformation": {
        "type": "object",
        "properties": {
          "extension_data": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ExtensionDataObject"
              }
            ],
            "description": "Extension data for customer Api response information",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user."
      },
      "RelatedArticleData": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The ID of the article",
            "nullable": true,
            "readOnly": true
          },
          "title": {
            "type": "string",
            "description": "The title of the article",
            "nullable": true
          },
          "hidden": {
            "type": "boolean",
            "description": "`True` indicates that the article is hidden"
          },
          "slug": {
            "type": "string",
            "description": "The slug of the article",
            "nullable": true,
            "readOnly": true
          }
        },
        "additionalProperties": false
      },
      "CustomFieldValueResponse": {
        "type": "object",
        "properties": {
          "field_id": {
            "type": "string",
            "description": "Unique identifier of the custom field definition",
            "nullable": true
          },
          "name": {
            "type": "string",
            "description": "The display name of the custom field",
            "nullable": true
          },
          "type": {
            "enum": [
              "text",
              "textArea",
              "dropdown",
              "multiSelectDropdown",
              "date",
              "boolean",
              "number"
            ],
            "type": "string",
            "allOf": [
              {
                "$ref": "#/components/schemas/CustomFieldType"
              }
            ],
            "description": "The type of the custom field. 0 = Text, 1 = TextArea, 2 = Dropdown, 3 = MultiSelectDropdown, 4 = Date, 5 = Boolean, 6 = Number",
            "x-enumNames": [
              "Text",
              "TextArea",
              "Dropdown",
              "MultiSelectDropdown",
              "Date",
              "Boolean",
              "Number"
            ],
            "x-enum-varnames": [
              "Text",
              "TextArea",
              "Dropdown",
              "MultiSelectDropdown",
              "Date",
              "Boolean",
              "Number"
            ],
            "x-ms-enum": {
              "name": "CustomFieldType",
              "modelAsString": true
            }
          },
          "value": {
            "description": "The value of the custom field. Type depends on field type:\r\n- Text/TextArea: string\r\n- Number: int or double\r\n- Boolean: bool\r\n- Date: DateTime\r\n- Dropdown: string (selected option ID)\r\n- MultiSelectDropdown: List<string> (array of selected option IDs)",
            "nullable": true
          },
          "options": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CustomFieldOptionResponse"
            },
            "description": "Available options for Dropdown and MultiSelectDropdown fields.\r\nOmitted for other field types.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Represents a custom field value with its definition metadata"
      },
      "CustomFieldType": {
        "enum": [
          "text",
          "textArea",
          "dropdown",
          "multiSelectDropdown",
          "date",
          "boolean",
          "number"
        ],
        "type": "string",
        "description": "Possible values: `\"text\"` = Text, `\"textArea\"` = TextArea, `\"dropdown\"` = Dropdown, `\"multiSelectDropdown\"` = MultiSelectDropdown, `\"date\"` = Date, `\"boolean\"` = Boolean, `\"number\"` = Number",
        "x-enumNames": [
          "Text",
          "TextArea",
          "Dropdown",
          "MultiSelectDropdown",
          "Date",
          "Boolean",
          "Number"
        ],
        "x-enum-varnames": [
          "Text",
          "TextArea",
          "Dropdown",
          "MultiSelectDropdown",
          "Date",
          "Boolean",
          "Number"
        ],
        "x-ms-enum": {
          "name": "CustomFieldType",
          "modelAsString": true
        }
      },
      "CustomFieldOptionResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The option ID (use this value when updating)",
            "nullable": true,
            "readOnly": true
          },
          "label": {
            "type": "string",
            "description": "The display label for the option",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Option definition for dropdown fields"
      }
    },
    "securitySchemes": {
      "api_token": {
        "type": "apiKey",
        "description": "The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to **Settings > Knowledge base portal > API tokens**. This token must correspond to a valid workspace and permission level.",
        "name": "api_token",
        "in": "header"
      }
    }
  }
}
````