> ## 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 a reader group ## OpenAPI ````json PUT /v2/Readers/groups/{groupId} { "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//edit/`. `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/Readers/groups/{groupId}": { "put": { "tags": [ "Readers" ], "summary": "Updates a reader group", "operationId": "updateReaderGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "The ID of the reader group. Fetch via `GET /v2/readers/groups`.", "required": true, "schema": { "type": "string" }, "example": "047ec4da-d8d3-4bfe-ae83-fff9f4e1f6ae" } ], "requestBody": { "description": "Partial reader group update payload. Only the fields present in the request body are updated.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateReaderGroupRequestV2" } ] }, "examples": { "ReadersGroup -Update an existing readers group with access level None.": { "summary": "Here you can edit the readers group with the access permission as None. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 0, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Article.": { "summary": "Here you can edit the readers group with the access permission as Article. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 5, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Category.": { "summary": "Here you can edit the readers group with the access permission as Category. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 1, "categories": [ { "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508vr4", "category_id": "fc7e-fcbe-4797-b144-1a7ca2508vfe433", "language_code": "en" } ], "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Language.": { "summary": "Here you can edit the readers group with the access permission as Language. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 4, "categories": null, "project_versions": null, "languages": [ { "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca250dd3e", "language_code": "en" } ] }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Project.": { "summary": "Here you can edit the readers group with the access permission as Project. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 3, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Version.": { "summary": "Here you can edit the readers group with the access permission as Version. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 2, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateReaderGroupRequestV2" } ] }, "examples": { "ReadersGroup -Update an existing readers group with access level None.": { "summary": "Here you can edit the readers group with the access permission as None. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 0, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Article.": { "summary": "Here you can edit the readers group with the access permission as Article. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 5, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Category.": { "summary": "Here you can edit the readers group with the access permission as Category. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 1, "categories": [ { "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508vr4", "category_id": "fc7e-fcbe-4797-b144-1a7ca2508vfe433", "language_code": "en" } ], "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Language.": { "summary": "Here you can edit the readers group with the access permission as Language. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 4, "categories": null, "project_versions": null, "languages": [ { "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca250dd3e", "language_code": "en" } ] }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Project.": { "summary": "Here you can edit the readers group with the access permission as Project. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 3, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Version.": { "summary": "Here you can edit the readers group with the access permission as Version. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 2, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateReaderGroupRequestV2" } ] }, "examples": { "ReadersGroup -Update an existing readers group with access level None.": { "summary": "Here you can edit the readers group with the access permission as None. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 0, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Article.": { "summary": "Here you can edit the readers group with the access permission as Article. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 5, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Category.": { "summary": "Here you can edit the readers group with the access permission as Category. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 1, "categories": [ { "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508vr4", "category_id": "fc7e-fcbe-4797-b144-1a7ca2508vfe433", "language_code": "en" } ], "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Language.": { "summary": "Here you can edit the readers group with the access permission as Language. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 4, "categories": null, "project_versions": null, "languages": [ { "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca250dd3e", "language_code": "en" } ] }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Project.": { "summary": "Here you can edit the readers group with the access permission as Project. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 3, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Version.": { "summary": "Here you can edit the readers group with the access permission as Version. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 2, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateReaderGroupRequestV2" } ] }, "examples": { "ReadersGroup -Update an existing readers group with access level None.": { "summary": "Here you can edit the readers group with the access permission as None. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 0, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Article.": { "summary": "Here you can edit the readers group with the access permission as Article. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 5, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Category.": { "summary": "Here you can edit the readers group with the access permission as Category. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 1, "categories": [ { "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508vr4", "category_id": "fc7e-fcbe-4797-b144-1a7ca2508vfe433", "language_code": "en" } ], "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Language.": { "summary": "Here you can edit the readers group with the access permission as Language. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 4, "categories": null, "project_versions": null, "languages": [ { "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca250dd3e", "language_code": "en" } ] }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Project.": { "summary": "Here you can edit the readers group with the access permission as Project. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 3, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } }, "ReadersGroup - Update an existing readers group with access level as Version.": { "summary": "Here you can edit the readers group with the access permission as Version. Also add groupId in the path to complete the request.", "value": { "title": "UpdatedReadersGroupName", "description": "For better undestanding update and breif this group description here.", "associated_readers": null, "access_scope": { "access_level": 2, "categories": null, "project_versions": null, "languages": null }, "associated_invited_sso_users": null } } } } }, "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/BooleanCustomerApiResponse" }, "examples": { "Readers - 200 Success response for Update reader groups": { "summary": "This is a sample success status response example.", "value": { "result": false, "extension_data": null, "success": true, "errors": null, "warnings": null, "information": null } } } } } }, "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": { "Readers - 400 response for group Id not found.": { "summary": "Kindly verify your group Id and perform the task again. You can verify your group Id from /v2/Readers/groups.", "value": { "extension_data": null, "success": false, "errors": [ { "extension_data": null, "stack_trace": null, "description": "The reader group Id does not exist.", "error_code": null, "custom_data": null } ], "warnings": null, "information": null } }, "Readers - 400 response for title not found.": { "summary": "Here the title is an mandatory field.", "value": { "extension_data": null, "success": false, "errors": [ { "extension_data": null, "stack_trace": null, "description": "The Title field is required.", "error_code": null, "custom_data": null } ], "warnings": null, "information": null } }, "Readers - 400 response for AccessScope not found.": { "summary": "Here the AccessScope is an mandatory field.", "value": { "extension_data": null, "success": false, "errors": [ { "extension_data": null, "stack_trace": null, "description": "The AccessScope field is required.", "error_code": null, "custom_data": null } ], "warnings": null, "information": null } } } } } }, "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": { "UpdateReaderGroupRequestV2": { "required": [ "access_scope", "title" ], "type": "object", "properties": { "title": { "minLength": 1, "pattern": "^[^~`!@#$%^&*)(+=|\\]\\[{};:?/>'.,]*$", "type": "string", "description": "The name of the reader group." }, "description": { "type": "string", "description": "Description of the reader group.", "nullable": true }, "associated_readers": { "type": "array", "items": { "type": "string" }, "description": " List of reader IDs to be associated with this reader group.\r\nNote: Reader IDs that were previously associated but not present in this list during the update will be dissociated from this reader group.", "nullable": true }, "access_scope": { "allOf": [ { "$ref": "#/components/schemas/AddUpdateAccessScopeCustomerV2" } ], "description": "Access level of this reader group." }, "associated_invited_sso_users": { "type": "array", "items": { "type": "string" }, "description": " List of invitation IDs to be associated with this reader group.\r\nNote: Invitation IDs that were previously associated but not present in this list during the update will be disassociated from this reader group.", "nullable": true } }, "additionalProperties": false }, "BooleanCustomerApiResponse": { "type": "object", "properties": { "result": { "type": "boolean", "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `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, "description": "Generic Customer API response envelope — a Document360.Core.Messages.Core.CustomerApiBaseResponse with a typed\r\nDocument360.Core.Messages.Common.CustomerApiResponse`1.Result payload. Used when the success-shape is a single strongly-typed value\r\n(an entity, list, count, etc.). Always check Document360.Core.Messages.Core.CustomerApiBaseResponse.success\r\nbefore consuming Document360.Core.Messages.Common.CustomerApiResponse`1.Result." }, "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 }, "AddUpdateAccessScopeCustomerV2": { "required": [ "access_level" ], "type": "object", "properties": { "access_level": { "enum": [ "none", "category", "version", "project", "language", "article", "workspace", "guides", "guideCategories" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccessScopeLevel" } ], "description": "This is an enum. Possible values are\r\n0 - None\r\n1 - Category\r\n2 - Version\r\n3 - Project\r\n4 - Lanaguage", "x-enumNames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories" ], "x-enum-varnames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories" ], "x-ms-enum": { "name": "AccessScopeLevel", "modelAsString": true } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryScopeCustomer" }, "description": "A list of category scope objects.\r\nThis is only required if the access level is set 1 - Category", "nullable": true }, "project_versions": { "type": "array", "items": { "type": "string" }, "description": "A list of project versions\r\nThis is only required if the access level is set to 2 - Version", "nullable": true }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageScopeCustomer" }, "description": "A list of language scope objects\r\nThis is only required if the access level is set to 4 - Language", "nullable": true } }, "additionalProperties": false, "description": "The access scope of the user" }, "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." }, "AccessScopeLevel": { "enum": [ "none", "category", "version", "project", "language", "article", "workspace", "guides", "guideCategories" ], "type": "string", "description": "This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage", "x-enumNames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories" ], "x-enum-varnames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories" ], "x-ms-enum": { "name": "AccessScopeLevel", "modelAsString": true } }, "CategoryScopeCustomer": { "required": [ "category_id", "language_code", "project_version_id" ], "type": "object", "properties": { "project_version_id": { "minLength": 1, "type": "string", "description": "The project version id to which the category belongs." }, "category_id": { "minLength": 1, "type": "string", "description": "The category id to which the user should be given access." }, "language_code": { "minLength": 1, "type": "string", "description": "The language to which the user should be given access." } }, "additionalProperties": false }, "LanguageScopeCustomer": { "required": [ "language_code", "project_version_id" ], "type": "object", "properties": { "project_version_id": { "minLength": 1, "type": "string", "description": "The project version id to which the user should be given access." }, "language_code": { "minLength": 1, "type": "string", "description": "The language to which the user should be given access." } }, "additionalProperties": false } }, "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" } } } } ````