{ "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, V2 and V3 are all stable. New endpoints and fields may be added without notice — 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" } } } ], "paths": { "/v2/APIReferences/{apiReferenceId}/Logs": { "get": { "tags": [ "APIReferences" ], "summary": "Gets all API reference logs", "description": "The product of `page * resultsPerPage` is capped at 20 — only the last 20 logs are accessible.", "operationId": "getApiReferenceLogs", "parameters": [ { "name": "apiReferenceId", "in": "path", "description": "The ID of the API reference whose logs to fetch.", "required": true, "schema": { "type": "string" }, "example": "0a39bfeb-90f8-4fb3-b37a-5838db6387f6" }, { "name": "page", "in": "query", "description": "1-based page number. Default: 1.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "resultsPerPage", "in": "query", "description": "Number of log entries per page. Default: 5.", "schema": { "type": "integer", "format": "int32", "default": 5 }, "example": 5 } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiReferenceLogsWrapResponseCustomer" }, "examples": { "Success status Response": { "summary": "This is the sample response for this endpoint. You can verify the individual logs in /v2/ApiReferences/{apiReferenceId}/Logs/{logId}.", "value": {"data":[{"logs_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","user_name":"Peter Jone","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","title":"Import successful","modified_at":"2024-06-13T14:30:00","error_count":12,"alerts_count":34},{"logs_id":"5g25c7e-fcbe-4797-b144-1a7ca2843tv4","user_name":"Theresa May","user_id":"d71efc6f-e968-4e95-82eb-85ad6155984rf","title":"Import successful","modified_at":"2024-06-13T14:30:00","error_count":12,"alerts_count":34}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Inalid API reference ID": { "summary": "Kindly ensure that the given API reference ID is valid.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Api reference not found.","error_code":null,"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": [ ] } ] } }, "/v2/APIReferences/{apiReferenceId}/Logs/{logId}": { "get": { "tags": [ "APIReferences" ], "summary": "Gets errors and alerts of a log", "operationId": "getApiReferenceErrorAndWarningLogs", "parameters": [ { "name": "apiReferenceId", "in": "path", "description": "The ID of the API reference.", "required": true, "schema": { "type": "string" }, "example": "0a39bfeb-90f8-4fb3-b37a-5838db6387f6" }, { "name": "logId", "in": "path", "description": "The ID of the log entry. Fetch via `GET /v2/apireferences/{apiReferenceId}/Logs`.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLogsDetailsResponseCustomer" }, "examples": { "Success status Response": { "summary": "This is the sample response for single API reference log.", "value": {"api_reference_errors":[{"message":"Declared path parameter \"contentId\" needs to be defined as a path parameter at either the path or operation level","pointer":"#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"}],"api_reference_alerts":[{"message":"Data and type mismatch found.","pointer":"#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Invalid API reference ID": { "summary": "Kindly ensure that the given API reference ID is valid.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Api reference not found.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid API reference log ID": { "summary": "Kindly ensure that the given log Id is in the API reference.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Logs not found.","error_code":null,"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": [ ] } ] } }, "/v2/APIReferences/jobs/{backgroundTaskId}": { "get": { "tags": [ "APIReferences" ], "summary": "Get the status of a background import or resync.", "description": "\n\r\n Import and resync return `background_task_id` with `is_processing: true` when the work\r\n outlives the request budget. That is not a failure — the job is still running. Poll this\r\n endpoint, or re-issue the identical import/resync request, which de-duplicates onto the same\r\n job rather than starting a second one.\r\n \r\n\n\r\n This surface needs its own route. The V3 `OperationsController` requires an OAuth bearer\r\n (`/v3` short-circuits API-token auth entirely), and the CLI route under `/v2/apidocs/` is\r\n closed to every token type except APIDocs — `ApiTokenValidationMiddleware` rejects a\r\n `PublicApi` token on any path containing `/apidocs/`.\r\n ", "operationId": "getJobStatus", "parameters": [ { "name": "backgroundTaskId", "in": "path", "description": "Id returned as `background_task_id` by import or resync.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDocumentationImportResponseCustomer" }, "examples": { "Success status Response": { "summary": "This is the sample response for single API reference import with server variables.", "value": {"data":{"categories_created":23,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[],"alerts":[]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Success status Response with no server variables": { "summary": "This is the sample response for single API reference import without server variables.", "value": {"data":{"categories_created":3,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[],"alerts":[]},"extension_data":null,"success":true,"errors":[],"warnings":[{"extension_data":null,"description":"You may not be able to use try-it feature. Looks like server variables aren’t defined in your OpenAPI Specification file.","warning_code":null}],"information":[]} }, "Success status Response for ForceImport as false": { "summary": "This is the sample response for single API reference import with force import as false.", "value": {"data":{"categories_created":3,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[{"message":"Declared path parameter 'contentId' needs to be defined as a path parameter at either the path or operation level","pointer":"#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"}],"alerts":[{"message":"Data and type mismatch found.","pointer":"#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","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": [ ] } ] } }, "/v2/APIReferences": { "post": { "tags": [ "APIReferences" ], "summary": "Imports the API reference spec file", "description": "Deprecated. This endpoint parses the specification inside the request, which is what made a\r\nlarge specification exhaust the API pod's memory. Prefer `POST /v2/APIReferences/jobs`, which\r\nanswers 202 with a `background_task_id` and runs the parse on a worker; poll it with\r\n`GET /v2/APIReferences/jobs/{backgroundTaskId}`. This endpoint still works, its response is\r\nunchanged, and it is not scheduled for removal.", "operationId": "addApiDocumentation", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ForceImport", "ProjectVersionId", "UserId" ], "type": "object", "properties": { "ProjectVersionId": { "type": "string", "description": "The ID of the workspace (also called project version) to import into. Fetch via `GET /v2/projectversions`." }, "UserId": { "type": "string", "description": "The ID of the team account performing the import. Fetch via `GET /v2/teams`." }, "ForceImport": { "type": "boolean", "description": "When `true`, the spec is imported even if validation errors or alerts are present. When `false`, validation issues block the import.", "default": true }, "Url": { "type": "string", "description": "URL pointing to the OpenAPI/Swagger spec to import. Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationImportRequestCustomer.File." }, "File": { "type": "string", "description": "Uploaded OpenAPI/Swagger spec file (JSON or YAML). Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationImportRequestCustomer.Url.", "format": "binary" } } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Add API reference request": { "summary": "Import an API reference with projectVersionId, userId and a spec file url or a file type.", "value": {"project_version_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","user_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","force_import":true,"url":"https://petstore.swagger.io/v2/swagger.json","file":null} } }, "encoding": { "ProjectVersionId": { "style": "form" }, "UserId": { "style": "form" }, "ForceImport": { "style": "form" }, "Url": { "style": "form" }, "File": { "style": "form" } } } } }, "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDocumentationImportResponseCustomer" }, "examples": { "Success status Response": { "summary": "This is the sample response for single API reference import with server variables.", "value": {"data":{"categories_created":23,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[],"alerts":[]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Success status Response with no server variables": { "summary": "This is the sample response for single API reference import without server variables.", "value": {"data":{"categories_created":3,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[],"alerts":[]},"extension_data":null,"success":true,"errors":[],"warnings":[{"extension_data":null,"description":"You may not be able to use try-it feature. Looks like server variables aren’t defined in your OpenAPI Specification file.","warning_code":null}],"information":[]} }, "Success status Response for ForceImport as false": { "summary": "This is the sample response for single API reference import with force import as false.", "value": {"data":{"categories_created":3,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[{"message":"Declared path parameter 'contentId' needs to be defined as a path parameter at either the path or operation level","pointer":"#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"}],"alerts":[{"message":"Data and type mismatch found.","pointer":"#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Inalid project Version ID": { "summary": "Kindly ensure that the given project version ID is valid.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id d2eafb73-ccb6-4d15-9c4a-959b3c232ddba does not exist in your project","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Inalid user ID": { "summary": "Kindly ensure that the given user ID is valid.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de8a' does not exist in your project.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Maximum API Reference limit reached": { "summary": "You had reached your maximum API reference limit, for continuing add a new version.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Unable to add API Reference: Maximum API Reference limit reached","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Supplied URL is invalid": { "summary": "You have to provide a valid OAS spec file URL.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Url","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Can`t upload both the file and the URL": { "summary": "You have to provide only a valid OAS spec file or a spec file URL.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"You can only upload URL or a spec file.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Supplied file type is invalid": { "summary": "You have to upload a valid JSON or a YAML file.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Only YAML or JSON files are allowed.","error_code":null,"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" } } } }, "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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "APIReferences" ], "summary": "Resyncs the API reference spec file", "description": "Resyncing overwrites the existing imported endpoint articles. Manually-authored articles are\r\nleft untouched.\r\n \r\nDeprecated. This endpoint parses the specification inside the request. Prefer\r\n`PUT /v2/APIReferences/jobs`, which answers 202 with a `background_task_id` and runs the parse\r\non a worker; poll it with `GET /v2/APIReferences/jobs/{backgroundTaskId}`. This endpoint still\r\nworks, its response is unchanged, and it is not scheduled for removal.", "operationId": "resyncApiDocumentation", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ApiReferenceId", "ForceImport", "ProjectVersionId", "UserId" ], "type": "object", "properties": { "ApiReferenceId": { "type": "string", "description": "The ID of the API reference to resync." }, "ProjectVersionId": { "type": "string", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`." }, "UserId": { "type": "string", "description": "The ID of the team account performing the resync. Fetch via `GET /v2/teams`." }, "ForceImport": { "type": "boolean", "description": "When `true`, the resync proceeds even if validation errors or alerts are present (and confirms deletions surfaced on a previous dry run). When `false`, validation issues block the resync.", "default": true }, "Url": { "type": "string", "description": "URL pointing to the OpenAPI/Swagger spec to resync from. Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationResyncRequestCustomer.File." }, "File": { "type": "string", "description": "Uploaded OpenAPI/Swagger spec file (JSON or YAML). Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationResyncRequestCustomer.Url.", "format": "binary" } } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Resync API reference request": { "summary": "Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.", "value": {"api_reference_id":"d2eafb73-ccb6-4d15-9c4a-959b3c232ddb","project_version_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","user_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","force_import":true,"url":"https://petstore.swagger.io/v2/swagger.json","file":null} } }, "encoding": { "ApiReferenceId": { "style": "form" }, "ProjectVersionId": { "style": "form" }, "UserId": { "style": "form" }, "ForceImport": { "style": "form" }, "Url": { "style": "form" }, "File": { "style": "form" } } } } }, "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDocumentationResyncResponseCustomer" }, "examples": { "Success status Response": { "summary": "This is the sample response for single API reference resync with server variables.", "value": {"data":{"errors":[],"alerts":[],"categories_created":23,"articles_created":23,"deleted_endpoints":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Success status Response with no server variables": { "summary": "This is the sample response for single API reference resync without server variables.", "value": {"data":{"errors":[],"alerts":[],"categories_created":3,"articles_created":23,"deleted_endpoints":null},"extension_data":null,"success":true,"errors":[],"warnings":[{"extension_data":null,"description":"You may not be able to use try-it feature. Looks like server variables aren’t defined in your OpenAPI Specification file.","warning_code":null}],"information":[]} }, "Success status Response for ForceImport as false": { "summary": "This is the sample response for single API reference resync with force import as false.", "value": {"data":{"errors":[{"message":"Declared path parameter 'contentId' needs to be defined as a path parameter at either the path or operation level","pointer":"#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"}],"alerts":[{"message":"Data and type mismatch found.","pointer":"#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"}],"categories_created":3,"articles_created":23,"deleted_endpoints":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Invalid project Version ID": { "summary": "Kindly ensure that the given project version ID is valid.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id d2eafb73-ccb6-4d15-9c4a-959b3c232ddba does not exist in your project","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid API reference ID": { "summary": "Kindly ensure that the given API reference ID is valid.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Api reference not found.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid user ID": { "summary": "Kindly ensure that the given user ID is valid.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de8a' does not exist in your project.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Maximum API Reference limit reached": { "summary": "You have reached your maximum API reference limit, for continuing add a new version.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Unable to add API Reference: Maximum API Reference limit reached","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Supplied URL is invalid": { "summary": "You have to provide a valid OAS spec file URL.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Url","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Can`t upload both the file and the URL": { "summary": "You have to provide only a valid OAS spec file or a spec file URL.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"You can only upload URL or a spec file.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Supplied file type is invalid": { "summary": "You have to upload a valid JSON or YAML file.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Only YAML or JSON files are allowed.","error_code":null,"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" } } } }, "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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] }, "delete": { "tags": [ "APIReferences" ], "summary": "Deletes an API reference", "operationId": "deleteApiReference", "parameters": [ { "name": "projectVersionId", "in": "query", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`.", "required": true, "schema": { "type": "string" }, "example": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234" }, { "name": "apiReferenceId", "in": "query", "description": "The ID of the API reference to delete.", "required": true, "schema": { "type": "string" }, "example": "0a39bfeb-90f8-4fb3-b37a-5838db6387f6" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteApiReferenceResponseCustomer" }, "examples": { "API reference deleted": { "summary": "API reference is deleted successfully.", "value": {"data":[{"api_reference_id":"0a39bfeb-90f8-4fb3-b37a-5838db6387f6","details":"Successfully deleted"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Invalid API reference": { "summary": "Kindly verify that the API reference ID is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id 99f4b8d5-ccbd-41c9-8892-57c2fcf338d2 does not exist in your project.","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/APIReferences/jobs": { "post": { "tags": [ "APIReferences" ], "summary": "Imports an API reference in the background.", "description": "\n\r\n Returns a `background_task_id` immediately instead of holding the connection for the\r\n whole import. Poll `GET /v2/apireferences/jobs/{backgroundTaskId}` until the job is no\r\n longer processing.\r\n \r\n\n\r\n `POST /v2/apireferences` is unchanged and stays supported. This is the migration target\r\n for specs large enough to hit the request timeout.\r\n \r\n\n\r\n Re-submitting an identical request does NOT start a second import — it returns the id of the\r\n job already running.\r\n ", "operationId": "importApiDocumentationAsync", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ForceImport", "ProjectVersionId", "UserId" ], "type": "object", "properties": { "ProjectVersionId": { "type": "string", "description": "The ID of the workspace (also called project version) to import into. Fetch via `GET /v2/projectversions`." }, "UserId": { "type": "string", "description": "The ID of the team account performing the import. Fetch via `GET /v2/teams`." }, "ForceImport": { "type": "boolean", "description": "When `true`, the spec is imported even if validation errors or alerts are present. When `false`, validation issues block the import.", "default": true }, "Url": { "type": "string", "description": "URL pointing to the OpenAPI/Swagger spec to import. Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationImportRequestCustomer.File." }, "File": { "type": "string", "description": "Uploaded OpenAPI/Swagger spec file (JSON or YAML). Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationImportRequestCustomer.Url.", "format": "binary" } } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "encoding": { "ProjectVersionId": { "style": "form" }, "UserId": { "style": "form" }, "ForceImport": { "style": "form" }, "Url": { "style": "form" }, "File": { "style": "form" } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDocumentationImportResponseCustomer" }, "examples": { "Success status Response": { "summary": "This is the sample response for single API reference import with server variables.", "value": {"data":{"categories_created":23,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[],"alerts":[]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Success status Response with no server variables": { "summary": "This is the sample response for single API reference import without server variables.", "value": {"data":{"categories_created":3,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[],"alerts":[]},"extension_data":null,"success":true,"errors":[],"warnings":[{"extension_data":null,"description":"You may not be able to use try-it feature. Looks like server variables aren’t defined in your OpenAPI Specification file.","warning_code":null}],"information":[]} }, "Success status Response for ForceImport as false": { "summary": "This is the sample response for single API reference import with force import as false.", "value": {"data":{"categories_created":3,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[{"message":"Declared path parameter 'contentId' needs to be defined as a path parameter at either the path or operation level","pointer":"#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"}],"alerts":[{"message":"Data and type mismatch found.","pointer":"#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","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" } } } }, "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": [ ] } ] }, "put": { "tags": [ "APIReferences" ], "summary": "Resyncs an API reference in the background.", "description": "Same contract as the async import. `force_import` keeps its meaning: without it the job\r\ncompletes reporting `deleted_endpoints` and refuses, and the caller re-submits with it\r\nset to confirm.\r\n\n\r\nThe `api_reference_id` is checked before the job is accepted, so an id that does not\r\nexist in this project is refused here rather than at `202`.\r\n", "operationId": "resyncApiDocumentationAsync", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ApiReferenceId", "ForceImport", "ProjectVersionId", "UserId" ], "type": "object", "properties": { "ApiReferenceId": { "type": "string", "description": "The ID of the API reference to resync." }, "ProjectVersionId": { "type": "string", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`." }, "UserId": { "type": "string", "description": "The ID of the team account performing the resync. Fetch via `GET /v2/teams`." }, "ForceImport": { "type": "boolean", "description": "When `true`, the resync proceeds even if validation errors or alerts are present (and confirms deletions surfaced on a previous dry run). When `false`, validation issues block the resync.", "default": true }, "Url": { "type": "string", "description": "URL pointing to the OpenAPI/Swagger spec to resync from. Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationResyncRequestCustomer.File." }, "File": { "type": "string", "description": "Uploaded OpenAPI/Swagger spec file (JSON or YAML). Mutually exclusive with Document360.Core.Messages.Public.ApiDocumentation.ApiDocumentationResyncRequestCustomer.Url.", "format": "binary" } } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "encoding": { "ApiReferenceId": { "style": "form" }, "ProjectVersionId": { "style": "form" }, "UserId": { "style": "form" }, "ForceImport": { "style": "form" }, "Url": { "style": "form" }, "File": { "style": "form" } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiDocumentationImportResponseCustomer" }, "examples": { "Success status Response": { "summary": "This is the sample response for single API reference import with server variables.", "value": {"data":{"categories_created":23,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[],"alerts":[]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Success status Response with no server variables": { "summary": "This is the sample response for single API reference import without server variables.", "value": {"data":{"categories_created":3,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[],"alerts":[]},"extension_data":null,"success":true,"errors":[],"warnings":[{"extension_data":null,"description":"You may not be able to use try-it feature. Looks like server variables aren’t defined in your OpenAPI Specification file.","warning_code":null}],"information":[]} }, "Success status Response for ForceImport as false": { "summary": "This is the sample response for single API reference import with force import as false.", "value": {"data":{"categories_created":3,"articles_created":23,"api_reference_id":"9874c1d9-033f-484c-8e3e-c343301eae57","errors":[{"message":"Declared path parameter 'contentId' needs to be defined as a path parameter at either the path or operation level","pointer":"#/paths/~1v2~1Content~1{Id}~1version~1{contentCategoryId}/delete/parameters/2/in"}],"alerts":[{"message":"Data and type mismatch found.","pointer":"#/paths/~1v2~1Content/{Id}/depete/response/200/content/application~1json/examples/Content"}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","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" } } } }, "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": [ ] } ] } }, "/v2/APIReferences/publish": { "post": { "tags": [ "APIReferences" ], "summary": "Publishes an API reference", "operationId": "publishArticles", "requestBody": { "description": "Publish payload — `projectVersionId` (fetch via `GET /v2/projectversions`), `apiReferenceId`, and `userId` (fetch via `GET /v2/teams`).", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiReferencePublishRequestCustomer" } ], "description": "Payload for `POST /v2/apireferences/publish` — publishes the endpoint articles imported from an API reference." }, "examples": { "Publish API reference Request Example": { "summary": "Publish an API reference with apiReferenceId, projectVersionId, and userId.", "value": {"api_reference_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiReferencePublishRequestCustomer" } ], "description": "Payload for `POST /v2/apireferences/publish` — publishes the endpoint articles imported from an API reference." }, "examples": { "Publish API reference Request Example": { "summary": "Publish an API reference with apiReferenceId, projectVersionId, and userId.", "value": {"api_reference_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiReferencePublishRequestCustomer" } ], "description": "Payload for `POST /v2/apireferences/publish` — publishes the endpoint articles imported from an API reference." }, "examples": { "Publish API reference Request Example": { "summary": "Publish an API reference with apiReferenceId, projectVersionId, and userId.", "value": {"api_reference_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ApiReferencePublishRequestCustomer" } ], "description": "Payload for `POST /v2/apireferences/publish` — publishes the endpoint articles imported from an API reference." }, "examples": { "Publish API reference Request Example": { "summary": "Publish an API reference with apiReferenceId, projectVersionId, and userId.", "value": {"api_reference_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8"} } } } }, "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/CustomerApiBaseResponse" }, "examples": { "API reference published successfully": { "summary": "API reference has been successfully published. You can view the published endpoints in the KB site.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Invalid API reference ID": { "summary": "Kindly verify the API reference ID and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid API reference","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid project version ID": { "summary": "Kindly verify the project version ID and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id 'd2eafb73-ccb6-4d15-9c4a-959b3c232ddba' does not exist in your project","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid user ID": { "summary": "Kindly verify the team account ID and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de8a' does not exist in your project.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "All articles are already in published state.": { "summary": "Since all the articles are already in a published state, they cannot be published again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"All articles are already in published state.","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/Articles": { "get": { "tags": [ "Articles" ], "summary": "Gets an article by URL", "description": "Resolves an article from its KB-site URL — useful when the integration only knows the public path, not the internal `articleId`.\r\nHonors any redirection rules configured for the article via `redirectionMode`. Use `0` (default) to ignore redirections, `1` to receive a 302 with the new URL, or `2` to silently follow the redirect.\r\nSafe to retry; idempotent.", "operationId": "getByUrl", "parameters": [ { "name": "url", "in": "query", "description": "The relative URL of the article (without domain). For example: \"/workspace/docs/en/article-slug\"", "required": true, "schema": { "type": "string" }, "example": "/v1/docs/en/getting-started" }, { "name": "redirectionMode", "in": "query", "description": "Determines how the API handles redirection when a redirection rule is configured for the requested article, category, or document.\r\n- 0 - None – Returns the content of the originally requested resource without applying any redirection.\r\n- 1 - RedirectOnly – Returns an HTTP 302 response along with the redirected resource's URL, without fetching its content.\r\n- 2 - RedirectWithContent – Automatically follows the redirection rule and returns the content of the final redirected resource.", "schema": { "enum": [ "none", "redirectOnly", "redirectWithContent" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RedirectionMode" } ], "description": "Possible values: `\"none\"` = None, `\"redirectOnly\"` = RedirectOnly, `\"redirectWithContent\"` = RedirectWithContent", "default": 0, "x-enumNames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-enum-varnames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-ms-enum": { "name": "RedirectionMode", "modelAsString": true } } }, { "name": "isForDisplay", "in": "query", "description": "Set this to true, if you are displaying the article to the end-user. If true, the content of snippets or variables appears in the article.", "schema": { "type": "boolean", "default": true }, "example": false }, { "name": "isPublished", "in": "query", "description": "True: You will get the latest published version of the article. False: To get the latest version of the article.", "schema": { "type": "boolean", "default": true }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set this to false to exclude appending SAS token for images/files.", "schema": { "type": "boolean", "default": true }, "example": 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/GetArticleByUrlResponse" } } } }, "302": { "description": "Resource has been redirected. The `Location` header carries the new URL.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "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": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "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" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","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" } } } }, "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": [ ] } ] }, "post": { "tags": [ "Articles" ], "summary": "Adds an article to an existing category", "description": "Creates a new article under the specified category in the workspace's default language. The returned `data.id` is the new article's `articleId` to use in subsequent calls.\r\nThe slug is auto-generated from the title unless an explicit `slug` is supplied; explicit slugs must be unique within the workspace.\r\n**Not idempotent** — retrying after a 5xx can create duplicates. Before retrying, list articles in the target category (`GET /v2/projectversions/{projectVersionId}/articles`) and check whether your new article already exists.", "operationId": "createArticle", "requestBody": { "description": "The article creation payload. The `categoryId` field is required (fetch via `GET /v2/projectversions/{projectVersionId}/categories`). When `contentType` is omitted, the project's default content type is used.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateArticleRequest" } ] }, "examples": { "Minimal — Markdown article": { "summary": "The smallest viable payload: title, content, and the destination category. The slug is auto-generated from the title; `contentType` defaults to the project's default editor.", "value": {"title":"Getting started with our SDK","content":"## Install\n\n`npm install @example/sdk`\n\n## Initialize\n\n```js\nconst client = new Client({ apiKey: 'YOUR_KEY' });\n```","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Block-editor article with explicit slug": { "summary": "Create a Block-editor article with a custom slug and ordering. `contentType` is set explicitly to override the project default; `slug` must be unique within the workspace.", "value": {"title":"Configure single sign-on with Okta","content":"{\"blocks\":[{\"type\":\"heading\",\"data\":{\"level\":2,\"text\":\"Prerequisites\"}},{\"type\":\"paragraph\",\"data\":{\"text\":\"You need an Okta admin account…\"}}]}","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":5,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":2,"slug":"configure-single-sign-on-with-okta"} }, "WYSIWYG (HTML) article": { "summary": "Create a WYSIWYG article. The `content` field carries HTML directly.", "value": {"title":"Release notes — Q4","content":"

This release introduces…

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":1,"slug":null} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateArticleRequest" } ] }, "examples": { "Minimal — Markdown article": { "summary": "The smallest viable payload: title, content, and the destination category. The slug is auto-generated from the title; `contentType` defaults to the project's default editor.", "value": {"title":"Getting started with our SDK","content":"## Install\n\n`npm install @example/sdk`\n\n## Initialize\n\n```js\nconst client = new Client({ apiKey: 'YOUR_KEY' });\n```","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Block-editor article with explicit slug": { "summary": "Create a Block-editor article with a custom slug and ordering. `contentType` is set explicitly to override the project default; `slug` must be unique within the workspace.", "value": {"title":"Configure single sign-on with Okta","content":"{\"blocks\":[{\"type\":\"heading\",\"data\":{\"level\":2,\"text\":\"Prerequisites\"}},{\"type\":\"paragraph\",\"data\":{\"text\":\"You need an Okta admin account…\"}}]}","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":5,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":2,"slug":"configure-single-sign-on-with-okta"} }, "WYSIWYG (HTML) article": { "summary": "Create a WYSIWYG article. The `content` field carries HTML directly.", "value": {"title":"Release notes — Q4","content":"

This release introduces…

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":1,"slug":null} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateArticleRequest" } ] }, "examples": { "Minimal — Markdown article": { "summary": "The smallest viable payload: title, content, and the destination category. The slug is auto-generated from the title; `contentType` defaults to the project's default editor.", "value": {"title":"Getting started with our SDK","content":"## Install\n\n`npm install @example/sdk`\n\n## Initialize\n\n```js\nconst client = new Client({ apiKey: 'YOUR_KEY' });\n```","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Block-editor article with explicit slug": { "summary": "Create a Block-editor article with a custom slug and ordering. `contentType` is set explicitly to override the project default; `slug` must be unique within the workspace.", "value": {"title":"Configure single sign-on with Okta","content":"{\"blocks\":[{\"type\":\"heading\",\"data\":{\"level\":2,\"text\":\"Prerequisites\"}},{\"type\":\"paragraph\",\"data\":{\"text\":\"You need an Okta admin account…\"}}]}","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":5,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":2,"slug":"configure-single-sign-on-with-okta"} }, "WYSIWYG (HTML) article": { "summary": "Create a WYSIWYG article. The `content` field carries HTML directly.", "value": {"title":"Release notes — Q4","content":"

This release introduces…

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":1,"slug":null} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateArticleRequest" } ] }, "examples": { "Minimal — Markdown article": { "summary": "The smallest viable payload: title, content, and the destination category. The slug is auto-generated from the title; `contentType` defaults to the project's default editor.", "value": {"title":"Getting started with our SDK","content":"## Install\n\n`npm install @example/sdk`\n\n## Initialize\n\n```js\nconst client = new Client({ apiKey: 'YOUR_KEY' });\n```","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Block-editor article with explicit slug": { "summary": "Create a Block-editor article with a custom slug and ordering. `contentType` is set explicitly to override the project default; `slug` must be unique within the workspace.", "value": {"title":"Configure single sign-on with Okta","content":"{\"blocks\":[{\"type\":\"heading\",\"data\":{\"level\":2,\"text\":\"Prerequisites\"}},{\"type\":\"paragraph\",\"data\":{\"text\":\"You need an Okta admin account…\"}}]}","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":5,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":2,"slug":"configure-single-sign-on-with-okta"} }, "WYSIWYG (HTML) article": { "summary": "Create a WYSIWYG article. The `content` field carries HTML directly.", "value": {"title":"Release notes — Q4","content":"

This release introduces…

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":1,"slug":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/CreateArticleResponse" }, "examples": { "Article Created Successfully": { "summary": "The article has been created under the following category. you can use the article Id to view the article in the portal.", "value": {"data":{"id":"925b69b9-f241-4d89-9e3e-208a98dfc8eb","title":"Sample Article","public_version":0,"latest_version":1,"language_code":null,"hidden":false,"status":0,"order":3,"slug":"sample-article","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":null,"current_workflow_status_id":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "userId not found": { "summary": "Kindly check your user Id and perform the task again. Find your user Id at /v2/Teams.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "category_id not found": { "summary": "Kindly check the category_id from /v2/ProjectVersions/{projectVersionId}/categories and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Unable to find specified parent category with an id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "project_version_id not found": { "summary": "Kindly check the project_version_id from /v2/ProjectVersions and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id 46f48bc7-760f-4b07-b2d2-fce4aa8ba2349 does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "title not found": { "summary": "Kindly check the title is empty or null, and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Title field 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" } } } }, "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": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}": { "get": { "tags": [ "Articles" ], "summary": "Gets an article", "description": "Returns one article translation. The response carries article body, metadata, available languages, security visibility, and any configured custom fields.\r\nUse `isForDisplay=true` only when rendering for end users (resolves snippet, variable, and glossary merge codes). Do not send the resolved content back to update endpoints.\r\nTo resolve an article from its KB URL instead of its ID, use `GET /v2/articles` with the `url` query parameter.", "operationId": "getArticle", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "path", "description": "Language code of the article 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" }, { "name": "isForDisplay", "in": "query", "description": "Set to `true` when rendering the article for an end-user — the response will resolve snippet, variable, and glossary merge codes. Do not pass `true` and then send the resolved content to an update endpoint.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "isPublished", "in": "query", "description": "When `true`, returns the latest published version (falls back to the latest draft if no published version exists). When `false`, returns the latest draft regardless of publish state.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": 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/GetArticleResponseCustomer" }, "examples": { "Markdown article (published)": { "summary": "A typical Markdown article in a public workspace. The `content` field carries Markdown source; `htmlContent` carries the rendered HTML.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":"Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.","html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","profile_logo_cdn_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"Knowledge-bases-are-much-easier-to-design-and edit","is_fall_back_content":false,"description":null,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"category_type":0,"content_type":null,"is_shared_article":false,"translation_option":0,"url":"https://example.com/v1/docs/en/getting-started","current_workflow_status_id":"56ad8f40-0d6d-4a23-897d-d85a26726791","available_languages":[{"lang_code":"fr","url":"getting-started","translation_status":2}],"security_visibility":0,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"USA"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":5},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"},{"id":"option-id-pending","label":"Pending"}]}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Block-editor article (private workspace)": { "summary": "A Block-editor article inside a private workspace. The `content` field is null; `htmlContent` carries the serialised block JSON. Image and file URLs in the rendered HTML carry SAS tokens because the project is private.", "value": {"data":{"id":"7c2e9f01-1a2b-4c3d-9e8f-2b3c4d5e6f70","title":"Configure single sign-on with Okta","content":null,"html_content":"

Prerequisites

You need an Okta admin account…

","category_id":"9bd4c220-5a1f-4b2e-8d7c-1e2f3a4b5c6d","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":4,"public_version":3,"latest_version":4,"enable_rtl":false,"hidden":false,"status":3,"version_type":null,"order":2,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","profile_logo_cdn_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"configure-single-sign-on-with-okta","is_fall_back_content":false,"description":"Step-by-step guide to wiring up Okta SSO.","stale_status":{"article_stale_status":1,"stale_reason":"Scheduled review reminder reached","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"category_type":0,"content_type":2,"is_shared_article":false,"translation_option":0,"url":"https://example.com/v1/docs/en/configure-single-sign-on-with-okta","current_workflow_status_id":"56ad8f40-0d6d-4a23-897d-d85a26726791","available_languages":[{"lang_code":"en","url":"configure-single-sign-on-with-okta","translation_status":2},{"lang_code":"de-DE","url":"configure-single-sign-on-with-okta","translation_status":3}],"security_visibility":1,"custom_fields":[]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "V2 Response (custom_fields_data)": { "summary": "V2 callers receive custom_fields_data instead of custom_fields. Values are in their native type — string, number, boolean. Date fields are ISO 8601 (UTC) strings. Multi-select fields are returned as a comma-separated string. Fields with no value are included as null.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":null,"html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":null,"authors":[],"created_at":"0001-01-01T00:00:00","modified_at":"0001-01-01T00:00:00","slug":null,"is_fall_back_content":false,"description":null,"stale_status":null,"category_type":null,"content_type":null,"is_shared_article":false,"translation_option":0,"url":"https://example.com/v1/docs/en/getting-started","current_workflow_status_id":null,"available_languages":[],"security_visibility":0,"custom_fields_data":{"Country":"USA","Priority":5,"Status":"Active","Tags":"Frontend, Backend","Is Published":true,"Publish Date":"2024-01-15T00:00:00.0000000Z","Notes":null}},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "The supplied `articleId` does not exist in the project, or no translation exists for the requested `langCode`. Verify both values with `GET /v2/projectversions/{projectVersionId}/articles` and `GET /v2/language/{projectVersionId}`.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Language not enabled for workspace": { "summary": "The article exists but the requested `langCode` is not enabled for the workspace. Use `GET /v2/language/{projectVersionId}` to list enabled languages.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language 'de-DE' is not enabled for this workspace.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid API token": { "summary": "The `api_token` header is missing, malformed, or revoked. Re-issue the token under **Settings → Knowledge base portal → API tokens** in the Document360 portal.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid or missing API token.","error_code":null,"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": [ ] } ] }, "put": { "tags": [ "Articles" ], "summary": "Updates an article with the ID", "description": "Partial update — only the fields present in the request body are written. Omitted fields preserve their current values.\r\nIdempotent: replaying the same body twice produces the same final state.\r\nUse `PUT /v2/articles/{articleId}/{langCode}/settings` for settings-only changes (slug, SEO, status indicator).", "operationId": "updateArticle", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "path", "description": "Language code of the article 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 update payload — only the fields present in the request body are updated. Do not pass content fetched with `isForDisplay=true`; the resolved merge codes would overwrite the source.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Update article wth article Id for default language": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0,"content_type":null} }, "Update article wth article Id for article in the state of need translation": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0,"content_type":null} }, "Update article wth article Id with translation you had made": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0,"content_type":null} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Update article wth article Id for default language": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0,"content_type":null} }, "Update article wth article Id for article in the state of need translation": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0,"content_type":null} }, "Update article wth article Id with translation you had made": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0,"content_type":null} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Update article wth article Id for default language": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0,"content_type":null} }, "Update article wth article Id for article in the state of need translation": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0,"content_type":null} }, "Update article wth article Id with translation you had made": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0,"content_type":null} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Update article wth article Id for default language": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"0","source":"uat","order":0,"content_type":null} }, "Update article wth article Id for article in the state of need translation": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"1","source":"uat","order":0,"content_type":null} }, "Update article wth article Id with translation you had made": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.", "value": {"title":"updated article title","content":"Hi this is an API article Sample. This is updated.","html_content":"

Hi this is an API article Sample. This is updated.

","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","hidden":true,"version_number":1,"translation_option":"2","source":"uat","order":0,"content_type":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/CreateArticleResponse" }, "examples": { "Article Created Successfully": { "summary": "The article has been created under the following category. you can use the article Id to view the article in the portal.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":"Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.","html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","profile_logo_cdn_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"Knowledge-bases-are-much-easier-to-design-and edit","is_fall_back_content":false,"description":null,"stale_status":null,"category_type":0,"content_type":null,"is_shared_article":false,"translation_option":0,"url":"https://example.com/v1/docs/en/getting-started","current_workflow_status_id":null,"available_languages":[],"security_visibility":0},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Article Not Found": { "summary": "Kindly verify the article Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","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": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/settings": { "get": { "tags": [ "Articles" ], "summary": "Gets settings for the article", "operationId": "getArticleSettingsWithLangCode", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "path", "description": "Language code of the article 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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleSettingsResponse" }, "examples": { "Success status Response": { "summary": "This is the sample response for Get-Article-Settings, You can verify the Slug, Tags, and relatedArticles.", "value": {"data":{"slug":"5-basic-things-to-get-started","seo_title":null,"description":null,"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":["Getting started"],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":false,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"USA"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":5},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"},{"id":"option-id-pending","label":"Pending"}]}]},"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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": [ ] } ] }, "put": { "tags": [ "Articles" ], "summary": "Updates settings for the article", "operationId": "updateArticleSettingsWithLangCode", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "path", "description": "Language code of the article 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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"show_published_version_log":null,"tags":[],"status_indicator":2,"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":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"show_published_version_log":null,"tags":[],"status_indicator":2,"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":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"show_published_version_log":null,"tags":[],"status_indicator":2,"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":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"show_published_version_log":null,"tags":[],"status_indicator":2,"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":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } } }, "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/UpdateArticleSettingsResponseCustomer" }, "examples": { "Successfully updated the article setings.": { "summary": "This response indicate a article settings has been successfully updated.", "value": {"data":{"url":"https://example.com/v1/docs/en/getting-started","slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","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":"","tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"Canada"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":8},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"}]}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Article 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": { "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": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/versions": { "get": { "tags": [ "Articles" ], "summary": "Gets all article versions", "operationId": "getArticleVersionsWithLangCode", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "path", "description": "Language code of the article 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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleVersionsResponse" }, "examples": { "Success Status Response": { "summary": "You can verify all the type of versions in a project.", "value": {"data":[{"version_number":1,"created_by":"peter jone","created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":0,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","comment":null,"version_type":null,"system_backup_ordinal":null}],"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/versions/{versionNumber}": { "get": { "tags": [ "Articles" ], "summary": "Gets article by a version number", "operationId": "getArticleVersionWithLangCode", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "versionNumber", "in": "path", "description": "Version number of the article. Use `GET /v2/articles/{articleId}/{langCode}/versions` to list versions.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "langCode", "in": "path", "description": "Language code of the article 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" }, { "name": "isForDisplay", "in": "query", "description": "Set to `true` when rendering the article for an end-user — the response will resolve snippet, variable, and glossary merge codes. Do not pass `true` and then send the resolved content to an update endpoint.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": 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/GetArticleVersionResponse" }, "examples": { "Success status Response": { "summary": "This is the sample response for get-article, You can verify the information regarding the individual article.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":"Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.","html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","profile_logo_cdn_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"Knowledge-bases-are-much-easier-to-design-and edit","is_fall_back_content":false,"description":null,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"category_type":0,"content_type":null,"is_shared_article":false,"translation_option":0,"version_created_at":"0001-01-01T00:00:00"},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "V2 Response (custom_fields_data)": { "summary": "V2 callers receive custom_fields_data instead of custom_fields. Values are in their native type: string, number, boolean. Multi-select fields are returned as a comma-separated string. Fields with no value are included as null.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":null,"html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":null,"authors":[],"created_at":"0001-01-01T00:00:00","modified_at":"0001-01-01T00:00:00","slug":null,"is_fall_back_content":false,"description":null,"stale_status":null,"category_type":null,"content_type":null,"is_shared_article":false,"translation_option":0,"version_created_at":"0001-01-01T00:00:00","custom_fields_data":{"Country":"USA","Priority":5,"Status":"Active","Tags":"Frontend, Backend","Is Published":true,"Notes":null}},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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": [ ] } ] } }, "/v2/Articles/{articleId}/settings": { "get": { "tags": [ "Articles" ], "summary": "Gets settings for the article", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `GET /v2/articles/{articleId}/{langCode}/settings`.", "operationId": "getArticleSettings", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleSettingsResponse" }, "examples": { "Success status Response": { "summary": "This is the sample response for Get-Article-Settings, You can verify the Slug, Tags, and relatedArticles.", "value": {"data":{"slug":"5-basic-things-to-get-started","seo_title":null,"description":null,"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":["Getting started"],"status_indicator":1,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":false,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"USA"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":5},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"},{"id":"option-id-pending","label":"Pending"}]}]},"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Articles" ], "summary": "Updates settings for the article", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `PUT /v2/articles/{articleId}/{langCode}/settings`.", "operationId": "updateArticleSettings", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" } ], "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"show_published_version_log":null,"tags":[],"status_indicator":2,"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":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"show_published_version_log":null,"tags":[],"status_indicator":2,"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":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"show_published_version_log":null,"tags":[],"status_indicator":2,"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":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateArticleSettingsRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","allow_comments":true,"show_table_of_contents":true,"show_published_version_log":null,"tags":[],"status_indicator":2,"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":"Canada"},{"field_id":"field-definition-id-2","value":8},{"field_id":"field-definition-id-3","value":"option-id-active"}]} } } } }, "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/UpdateArticleSettingsResponseCustomer" }, "examples": { "Successfully updated the article setings.": { "summary": "This response indicate a article settings has been successfully updated.", "value": {"data":{"url":"https://example.com/v1/docs/en/getting-started","slug":"updatearticlesettings","seo_title":"update","description":"This is the description for updating article settings.","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":"","tags":[],"status_indicator":2,"status_indicator_expiry_date":"2024-06-13T14:30:00","exclude_from_search":true,"exclude_from_ai_search":false,"exclude_from_external_search":false,"related_articles":[],"is_acknowledgement_enabled":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Country","type":0,"value":"Canada"},{"field_id":"field-definition-id-2","name":"Priority","type":6,"value":8},{"field_id":"field-definition-id-3","name":"Status","type":2,"value":"option-id-active","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"}]}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Article 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": { "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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/versions": { "get": { "tags": [ "Articles" ], "summary": "Gets all article versions", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `GET /v2/articles/{articleId}/{langCode}/versions`.", "operationId": "getArticleVersions", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticleVersionsResponse" }, "examples": { "Success Status Response": { "summary": "You can verify all the type of versions in a project.", "value": {"data":[{"version_number":1,"created_by":"peter jone","created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":0,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","comment":null,"version_type":null,"system_backup_ordinal":null}],"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/versions/{versionNumber}": { "get": { "tags": [ "Articles" ], "summary": "Gets article by a version number", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `GET /v2/articles/{articleId}/{langCode}/versions/{versionNumber}`.", "operationId": "getArticleVersion", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "versionNumber", "in": "path", "description": "Version number of the article. Use `GET /v2/articles/{articleId}/{langCode}/versions` to list versions.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "isForDisplay", "in": "query", "description": "Set to `true` when rendering the article for an end-user — the response will resolve snippet, variable, and glossary merge codes. Do not pass `true` and then send the resolved content to an update endpoint.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": 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/GetArticleVersionResponse" }, "examples": { "Success status Response": { "summary": "This is the sample response for get-article, You can verify the information regarding the individual article.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":"Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.","html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","user_description":null,"unique_user_name":"peter-jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","profile_logo_cdn_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","is_enterprise_user":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"Knowledge-bases-are-much-easier-to-design-and edit","is_fall_back_content":false,"description":null,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"category_type":0,"content_type":null,"is_shared_article":false,"translation_option":0,"version_created_at":"0001-01-01T00:00:00"},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "V2 Response (custom_fields_data)": { "summary": "V2 callers receive custom_fields_data instead of custom_fields. Values are in their native type: string, number, boolean. Multi-select fields are returned as a comma-separated string. Fields with no value are included as null.", "value": {"data":{"id":"a1096061-e842-41fd-9085-494095e401b9","title":"Knowledge bases are much easier to design and edit","content":null,"html_content":null,"category_id":"de104b39-db97-4509-8d4c-deeac74d448b","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":null,"authors":[],"created_at":"0001-01-01T00:00:00","modified_at":"0001-01-01T00:00:00","slug":null,"is_fall_back_content":false,"description":null,"stale_status":null,"category_type":null,"content_type":null,"is_shared_article":false,"translation_option":0,"version_created_at":"0001-01-01T00:00:00","custom_fields_data":{"Country":"USA","Priority":5,"Status":"Active","Tags":"Frontend, Backend","Is Published":true,"Notes":null}},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/publish": { "post": { "tags": [ "Articles" ], "summary": "Publishes an article with an id", "description": "Marks the selected draft version as the current published version for the (article, language) pair. Idempotent — publishing an already-published version is a no-op.\r\nUse `DELETE /v2/articles/{articleId}/{langCode}/publish` to unpublish.", "operationId": "publishArticleWithLangCode", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "path", "description": "Language code of the article 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": "The publish payload. `versionNumber` selects which draft version to publish; `publishMessage` is an optional changelog note.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } } }, "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/CreateArticleResponse" }, "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"url":"https://example.com/v1/docs/en/getting-started","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "ALready published Article": { "summary": "This is repeated task that, this article has already published ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article has already been published.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number Not Found": { "summary": "version_number is missing or null, kindly verify the version number and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "article_id Not Found": { "summary": "Kindly verify the article_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"One or more errors occurred. (Article not found).","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "article Not Found": { "summary": "Kindly verify the articleId or langCode and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found.","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": [ ] } ] }, "delete": { "tags": [ "Articles" ], "summary": "Unpublishes an article with an id", "description": "Reverts the (article, language) pair from `Published` back to `Draft`. The article remains in the project but is removed from the public KB site.\r\nIdempotent — unpublishing an already-unpublished article is a no-op. To re-publish, use `POST /v2/articles/{articleId}/{langCode}/publish`.", "operationId": "unpublishArticleWithLangCode", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "path", "description": "Language code of the article 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": "Unpublish payload. `versionNumber` selects which published version to unpublish; `unpublishMessage` is an optional changelog note.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Unpublishing an article with ArticleId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Unpublishing my article."} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Unpublishing an article with ArticleId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Unpublishing my article."} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Unpublishing an article with ArticleId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Unpublishing my article."} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Unpublishing an article with ArticleId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Unpublishing my article."} } } } }, "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/CreateArticleResponse" }, "examples": { "Unpublish Article Request Example": { "summary": "Unublishing an article with ArticleId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"url":"https://example.com/v1/docs/en/getting-started","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Already unpublished article": { "summary": "This is repeated task that, this article has already unpublished ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article has already been unpublished.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number Not Found": { "summary": "version_number is missing or null, kindly verify the version number and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "article_id Not Found": { "summary": "Kindly verify the article_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"One or more errors occurred. (Article not found).","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "article Not Found": { "summary": "Kindly verify the articleId or langCode and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found.","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": [ ] } ] } }, "/v2/Articles/{articleId}/publish": { "post": { "tags": [ "Articles" ], "summary": "Publishes an article with an id", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `POST /v2/articles/{articleId}/{langCode}/publish`.", "operationId": "publishArticle", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" } ], "requestBody": { "description": "The publish payload. `versionNumber` selects which draft version to publish; `publishMessage` is an optional changelog note.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publishing my article with new changes."} } } } }, "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/CreateArticleResponse" }, "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"url":"https://example.com/v1/docs/en/getting-started","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "ALready published Article": { "summary": "This is repeated task that, this article has already published ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article has already been published.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number Not Found": { "summary": "version_number is missing or null, kindly verify the version number and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "article_id Not Found": { "summary": "Kindly verify the article_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"One or more errors occurred. (Article not found).","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "article Not Found": { "summary": "Kindly verify the articleId or langCode and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found.","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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/bulkcreate": { "post": { "tags": [ "Articles" ], "summary": "Adds multiple articles", "description": "Bulk variant of `POST /v2/articles`. Each entry is processed independently; if one entry fails validation, the response surfaces the per-entry error while the rest still get created.\r\n**Not idempotent** — retrying after a partial failure may create duplicates of the entries that originally succeeded. Filter your retry payload to only the failed entries.", "operationId": "bulkCreateArticle", "requestBody": { "description": "A list of article creation requests. For each article, the `slug` property is optional — if not provided, a slug is auto-generated from the title. When provided, the slug must be unique within the workspace, otherwise an error is returned for that article.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateArticleRequest" } }, "examples": { "Create Bulk Article Request Example": { "summary": "Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.", "value": [{"title":"New Article 1","content":"This is my first article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"title":"New Article 2","content":"This is my second article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateArticleRequest" } }, "examples": { "Create Bulk Article Request Example": { "summary": "Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.", "value": [{"title":"New Article 1","content":"This is my first article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"title":"New Article 2","content":"This is my second article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateArticleRequest" } }, "examples": { "Create Bulk Article Request Example": { "summary": "Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.", "value": [{"title":"New Article 1","content":"This is my first article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"title":"New Article 2","content":"This is my second article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateArticleRequest" } }, "examples": { "Create Bulk Article Request Example": { "summary": "Create Bulk artilce by adding a list of data in title, category_id, project_version_id, and user_id. use content property to add some data in to your article.", "value": [{"title":"New Article 1","content":"This is my first article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"title":"New Article 2","content":"This is my second article Content.","category_id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":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/BulkCreateArticleResponseCustomer" }, "examples": { "Article Created Successfully": { "summary": "The article has been created under the following category. you can use the article Id to view the article in the portal.", "value": {"data":[{"index":0,"article_id":"d83f3388-7493-489f-ab51-249d4e6a25ce","lang_code":null,"success":true,"details":"Successfully created article c1"},{"index":0,"article_id":"5cabbba1-fc2a-4f82-9dee-01759509b109","lang_code":null,"success":true,"details":"Successfully created article c2"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "userId not found": { "summary": "Kindly check your user Id and perform the task again. Find your user Id at /v2/Teams.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to create article c2\r\nError: The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "project_version_id not foundd": { "summary": "Kindly check the project_version_id from /v2/ProjectVersions and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to create article c1\r\nError: The supplied workspace id 46f48bc7-760f-4b07-b2d2-fce4aa8ba2341 does not exist in your project..","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "category_id not found": { "summary": "Kindly check the category_id from /v2/ProjectVersions/{projectVersionId}/categories and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to create article c1\r\nError: Unable to find specified parent category with an id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "title not found": { "summary": "Kindly check the title is empty or null, and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Title field 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" } } } }, "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": [ ] } ] } }, "/v2/Articles/bulkpublish/{langCode}": { "post": { "tags": [ "Articles" ], "summary": "Publishes multiple articles", "operationId": "bulkPublishArticle", "parameters": [ { "name": "langCode", "in": "path", "description": "Language code of the article 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": "The bulk publish payload listing the articles and version numbers to publish.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishArticle" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": [{"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"multiple article published"},{"article_id":"2ce2607f-6cfa-4bc9-9e47-1dc3843198629","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"multiple article published"}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishArticle" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": [{"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"multiple article published"},{"article_id":"2ce2607f-6cfa-4bc9-9e47-1dc3843198629","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"multiple article published"}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishArticle" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": [{"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"multiple article published"},{"article_id":"2ce2607f-6cfa-4bc9-9e47-1dc3843198629","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"multiple article published"}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishArticle" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": [{"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"multiple article published"},{"article_id":"2ce2607f-6cfa-4bc9-9e47-1dc3843198629","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"multiple article published"}] } } } }, "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/CreateArticleResponse" }, "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"data":[{"index":0,"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","lang_code":null,"success":true,"details":"Successfully published article with an id 8bcd4bf9-eb93-40d9-a8df-c3b518660ceb"},{"index":0,"article_id":"99575fe3-f7b0-4e0a-bc46-38aed8c621f9","lang_code":null,"success":true,"details":"Successfully published article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "already published article": { "summary": "This article has been already published.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to publish article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9\r\nError: Article has already been published.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verfy the user_id is not null or empty, and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to publish article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9\r\nError: The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "article_id not found": { "summary": "Invalid article_id or null reference, verify the article Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The ArticleId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "Invalid datatype for version_number, Kindly use integer value perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","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": [ ] } ] }, "delete": { "tags": [ "Articles" ], "summary": "Unpublishes multiple articles", "operationId": "bulkUnpublishArticle", "parameters": [ { "name": "langCode", "in": "path", "description": "Language code of the article 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": "Bulk unpublish payload listing the articles and version numbers to unpublish.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"articles":[{"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","version_number":1},{"article_id":"2ce2607f-6cfa-4bc9-9e47-1dc3843198629","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"multiple article unpublished"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"articles":[{"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","version_number":1},{"article_id":"2ce2607f-6cfa-4bc9-9e47-1dc3843198629","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"multiple article unpublished"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"articles":[{"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","version_number":1},{"article_id":"2ce2607f-6cfa-4bc9-9e47-1dc3843198629","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"multiple article unpublished"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishArticleRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Article Request Example": { "summary": "Publishing an article with ArticleId, langCode, user_id, version_number, and publish_message.", "value": {"articles":[{"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","version_number":1},{"article_id":"2ce2607f-6cfa-4bc9-9e47-1dc3843198629","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"multiple article unpublished"} } } } }, "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/BulkUnpublishArticleResponse" }, "examples": { "Unpublish article request example": { "summary": "Unpublishing an article with ArticleId, project_version_id, langCode, user_id, version_number, and unpublish_message.", "value": {"data":[{"index":0,"article_id":"8bcd4bf9-eb93-40d9-a8df-c3b518660ceb","lang_code":null,"success":true,"details":"Successfully unpublished article with an id 8bcd4bf9-eb93-40d9-a8df-c3b518660ceb"},{"index":0,"article_id":"99575fe3-f7b0-4e0a-bc46-38aed8c621f9","lang_code":null,"success":true,"details":"Successfully unpublished article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "already unpublished article": { "summary": "This article has been already unpublished.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to unpublish article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9\r\nError: Article has already been unpublished.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verfy the user_id is not null or empty, and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to unpublish article with an id 99575fe3-f7b0-4e0a-bc46-38aed8c621f9\r\nError: The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "article_id not found": { "summary": "Invalid article_id or null reference, verify the article Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The ArticleId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "Invalid datatype for version_number, Kindly use integer value perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","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": [ ] } ] } }, "/v2/Articles/update-workflow": { "post": { "tags": [ "Articles" ], "summary": "Update workflow status of the articles", "operationId": "updateArticleWorkflowStatus", "requestBody": { "description": "Workflow update payload. `projectVersionId` identifies the workspace, `articleIds` lists the affected articles, and `workflowStatusInfo` carries the new status, assignee, and due date.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ArticleUpdateWorkflowRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","article_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ArticleUpdateWorkflowRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","article_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ArticleUpdateWorkflowRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","article_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ArticleUpdateWorkflowRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","article_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} } }, "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/CustomerApiBaseResponse" }, "examples": { "Update Workflow - 200 Success response.": { "summary": "The below example shows a successful workflow update response", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Missing ProjectDocumentVersionId": { "summary": "The 'ProjectDocumentVersionId' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"ProjectDocumentVersion ID is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing LangCode": { "summary": "The 'LangCode' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language code is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing UserId": { "summary": "The 'UserId' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"User Id is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing DocumentIds": { "summary": "The 'DocumentIds' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Document IDs are required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing WorkflowStatusInfo": { "summary": "The 'WorkflowStatusInfo' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Workflow status information 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" } } } }, "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": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/updateDescription": { "put": { "tags": [ "Articles" ], "summary": "Update the article description", "operationId": "updateArticleDescriptionWithLangCode", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "description", "in": "query", "description": "The new description for the article (maximum 250 characters).", "schema": { "maxLength": 250, "type": "string" }, "example": "Step-by-step guide to wiring up Okta SSO." }, { "name": "langCode", "in": "path", "description": "Language code of the article 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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Kindly verify the language code.": { "summary": "Verify the language code and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} }, "Kindly verify the article Id.": { "summary": "Verify the article Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","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": [ ] } ] } }, "/v2/Articles/{articleId}/fork": { "put": { "tags": [ "Articles" ], "summary": "Forks an article with an id", "operationId": "forkArticleVersion", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" } ], "requestBody": { "description": "Fork payload — `versionNumber` selects the source version, `langCode` selects the translation (defaults to `en`), and `userId` records the author.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkArticleVersionRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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": {"version_number":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkArticleVersionRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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": {"version_number":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkArticleVersionRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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": {"version_number":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkArticleVersionRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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": {"version_number":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } } }, "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/ForkArticleVersionResponse" }, "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": {"data":{"version_number":4,"created_by":"peter jone","created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":3,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","comment":null,"version_type":null,"system_backup_ordinal":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "user_id not found.": { "summary": "Kindly verify the user_id and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "lang_code not found.": { "summary": "Kindly verify the lang_code and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The LangCode field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found.": { "summary": "Kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Cannot fork version number 0, it does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Article Id not found.": { "summary": "Kindly verify the Article Id and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"One or more errors occurred. (Article not found).","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": [ ] } ] } }, "/v2/Articles/{articleId}/updateDescription": { "put": { "tags": [ "Articles" ], "summary": "Update the article description", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `PUT /v2/articles/{articleId}/{langCode}/updateDescription`.", "operationId": "updateArticleDescription", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "description", "in": "query", "description": "The new description for the article (maximum 250 characters).", "schema": { "maxLength": 250, "type": "string" }, "example": "Step-by-step guide to wiring up Okta SSO." } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article settings update request.": { "summary": "This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Kindly verify the language code.": { "summary": "Verify the language code and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} }, "Kindly verify the article Id.": { "summary": "Verify the article Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/bulkupdate": { "put": { "tags": [ "Articles" ], "summary": "Updates multiple articles", "operationId": "bulkUpdateArticle", "requestBody": { "description": "Bulk update payload. Each entry is a partial article update — only the fields present in each entry are updated.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateArticle" } }, "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": [{"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","title":"Updated Title","content":"updating content","html_content":"

updating content

","category_id":"68212cec-7a9b-4323-9bb8-33865444a508","hidden":false,"version_number":1,"translation_option":"","source":"","order":0,"content_type":null}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateArticle" } }, "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": [{"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","title":"Updated Title","content":"updating content","html_content":"

updating content

","category_id":"68212cec-7a9b-4323-9bb8-33865444a508","hidden":false,"version_number":1,"translation_option":"","source":"","order":0,"content_type":null}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateArticle" } }, "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": [{"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","title":"Updated Title","content":"updating content","html_content":"

updating content

","category_id":"68212cec-7a9b-4323-9bb8-33865444a508","hidden":false,"version_number":1,"translation_option":"","source":"","order":0,"content_type":null}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateArticle" } }, "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": [{"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","title":"Updated Title","content":"updating content","html_content":"

updating content

","category_id":"68212cec-7a9b-4323-9bb8-33865444a508","hidden":false,"version_number":1,"translation_option":"","source":"","order":0,"content_type":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/BulkUpdateArticleResponse" }, "examples": { "Success response for bulk article update.": { "summary": "This is an response that indicate the bulk articles has updated successfully.", "value": {"data":[{"index":0,"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"en","success":true,"details":"Successfully updated article with an id 0e9a3cf2-b5ce-46d4-a637-604cb8407b93"},{"index":1,"article_id":"0e9a3cf2-b5ce-46d4-a637-604cb8407b93","lang_code":"fr","success":false,"details":"Failed to update article with an id 0e9a3cf2-b5ce-46d4-a637-604cb8407b93\nError: Article not found for the specified language."}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "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" } } } }, "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": [ ] } ] } }, "/v2/Articles/{articleId}": { "delete": { "tags": [ "Articles" ], "summary": "Deletes an article with an ID", "description": "Soft delete — all translations of the article and all its version history are removed from the workspace. Idempotent — deleting an already-deleted article returns `404`.\r\nTo remove only one specific version, use `DELETE /v2/articles/{articleId}/{langCode}/version/{versionNumber}`.", "operationId": "delete", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article Deleted Successfully": { "summary": "Article has been successfully deleted. This file cannot be retrived or undo.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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": [ ] } ] } }, "/v2/Articles/{articleId}/{langCode}/version/{versionNumber}": { "delete": { "tags": [ "Articles" ], "summary": "Deletes an article version", "operationId": "deleteArticleVersionWithLangCode", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "versionNumber", "in": "path", "description": "Version number of the article. Use `GET /v2/articles/{articleId}/{langCode}/versions` to list versions.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "langCode", "in": "path", "description": "Language code of the article 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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article Deleted Successfully": { "summary": "Article has been successfully deleted. This file cannot be retrived or undo.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Article Version not found": { "summary": "Kindly verify your versionNumber and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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": [ ] } ] } }, "/v2/Articles/{articleId}/version/{versionNumber}": { "delete": { "tags": [ "Articles" ], "summary": "Deletes an article version", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `DELETE /v2/articles/{articleId}/{langCode}/version/{versionNumber}`.", "operationId": "deleteArticleVersion", "parameters": [ { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "versionNumber", "in": "path", "description": "Version number of the article. Use `GET /v2/articles/{articleId}/{langCode}/versions` to list versions.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Article Deleted Successfully": { "summary": "Article has been successfully deleted. This file cannot be retrived or undo.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Article Version not found": { "summary": "Kindly verify your versionNumber and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Articles/bulkdelete": { "delete": { "tags": [ "Articles" ], "summary": "Deletes multiple articles", "operationId": "bulkDeleteArticles", "parameters": [ { "name": "articleIds", "in": "query", "description": "Array of article IDs to delete. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteArticleResponse" }, "examples": { "Successfully deleted bulk article": { "summary": "This states that the bulk article has been deleted successfully.", "value": {"data":[{"index":0,"article_id":null,"lang_code":null,"success":true,"details":"Successfully deleted article with an id 4b10a0b0-7300-4f0d-b2cd-47c619af4047"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Article Id not found": { "summary": "Kindly verify the article Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to delete article with an id 4b10a0b0-7300-4f0d-b2cd-47c619af4047\r\nError: Article not found","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/Articles/bulkdelete-article-versions": { "delete": { "tags": [ "Articles" ], "summary": "Delete multiple article versions", "operationId": "bulkDeleteArticleVersions", "parameters": [ { "name": "articleId", "in": "query", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "query", "description": "Language code of the article translation (for example `en`, `fr`, `de-DE`, `pt-BR`). Use `GET /v2/language/{projectVersionId}` to list the codes enabled for a workspace.", "required": true, "schema": { "type": "string" }, "example": "en" }, { "name": "articleVersionNumbers", "in": "query", "description": "Array of article version numbers to delete. Use `GET /v2/articles/{articleId}/{langCode}/versions` to list versions.", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteArticleVersionResonse" }, "examples": { "Articles Deleted Successfully": { "summary": "Article has been successfully deleted. This file cannot be retrived or undo.", "value": {"article_id":"00966e87-2f6c-4844-b586-ccc81ddab056","data":"Deleted article version(s) are 1,2,3","extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Article not found": { "summary": "Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Article not found","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Article Version not found": { "summary": "Kindly verify your articleVersion and perform the task again. Also verify the langCode (language code) is mismatching.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Article Version","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/Categories": { "get": { "tags": [ "Categories" ], "summary": "Gets a category by URL", "operationId": "getByUrl", "parameters": [ { "name": "url", "in": "query", "description": "The relative URL of the category (without domain). For example: \"/workspace/docs/en/category-slug\"", "required": true, "schema": { "type": "string" }, "example": "/v1/docs/en/getting-started" }, { "name": "redirectionMode", "in": "query", "description": "Determines how the API handles redirection when a redirection rule is configured for the requested article, category, or document.\r\n- 0 - None – Returns the content of the originally requested resource without applying any redirection.\r\n- 1 - RedirectOnly – Returns an HTTP 302 response along with the redirected resource's URL, without fetching its content.\r\n- 2 - RedirectWithContent – Automatically follows the redirection rule and returns the content of the final redirected resource.", "schema": { "enum": [ "none", "redirectOnly", "redirectWithContent" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RedirectionMode" } ], "description": "Possible values: `\"none\"` = None, `\"redirectOnly\"` = RedirectOnly, `\"redirectWithContent\"` = RedirectWithContent", "default": 0, "x-enumNames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-enum-varnames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-ms-enum": { "name": "RedirectionMode", "modelAsString": true } } }, { "name": "isForDisplay", "in": "query", "description": "Set to `true` when rendering the category for an end-user — the response will resolve snippet, variable, and glossary merge codes.", "schema": { "type": "boolean", "default": true }, "example": false }, { "name": "isPublished", "in": "query", "description": "When `true`, returns the latest published version. When `false`, returns the latest draft.", "schema": { "type": "boolean", "default": true }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": 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/GetCategoryByUrlResponse" } } } }, "302": { "description": "Resource has been redirected. The `Location` header carries the new URL.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "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": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "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" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","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" } } } }, "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": [ ] } ] }, "post": { "tags": [ "Categories" ], "summary": "Adds a new category", "description": "Creates a new category in the workspace's default language. The returned `data.id` is the new category's `categoryId` for subsequent calls.\r\nDefault category type is `Folder` (groups child categories and articles). To create a page-style category with its own content, pass `categoryType = 1` (Page).\r\n**Not idempotent** — list categories first (`GET /v2/projectversions/{projectVersionId}/categories`) before retrying after a 5xx.", "operationId": "addCategory", "requestBody": { "description": "The category creation payload. `name` is required; `parentCategoryId` places the category as a child of an existing category (omit for a root-level category — fetch via `GET /v2/projectversions/{projectVersionId}/categories`).", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCategoryRequest" } ] }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Page .": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCategoryRequest" } ] }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Page .": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCategoryRequest" } ] }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Page .": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddCategoryRequest" } ] }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Page .": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null} }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": {"name":"New Category","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":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/AddCategoryResponse" }, "examples": { "Successfully Created the Category": { "summary": "Here you can find the Category Id and category name to navigate.", "value": {"data":{"id":"df574e5a-8015-428f-ac33-cad428d1230c","name":"New Category","order":0,"icon":null},"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Invalid Category project_version_id Parameters": { "summary": "Kindly verify the project_version_id, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id 46fvf48bc7-760f-4b07-b2d2-fce4aa8ba234 does not exist in your project","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Empty project_version_id Parameters": { "summary": "Kindly verify the project_version_id is not empty, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The ProjectVersionId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Invalid Category Name Parameter": { "summary": "Kindly verify the Name, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Name field 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" } } } }, "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": [ ] } ] } }, "/v2/Categories/{categoryId}": { "get": { "tags": [ "Categories" ], "summary": "Gets a category by ID with its articles and direct child categories metadata", "description": "Returns category metadata, direct child categories, and articles in this category. Does NOT recurse into child categories — to walk the full tree, request each child category in turn.\r\nFor category content (the page body of an `Index` or `Page` type category), use `GET /v2/categories/{categoryId}/content/{langCode}`.", "operationId": "getCategory", "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": "query", "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. When omitted, the default language of the category is used.", "schema": { "type": "string" }, "example": "en" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryResponse" }, "examples": { "Success Response": { "summary": "This is an example for get category succes response. \\n Here you can view diffrent data included with multiple article associated with a category.", "value": {"data":{"articles":[{"id":"cf8f67da-77c7-48b1-b207-70875caa2f55","title":"New article 1","public_version":1,"latest_version":1,"language_code":"en","hidden":false,"status":0,"order":2,"slug":"new-article-1","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":"2024-06-13T14:30:00","current_workflow_status_id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086"},{"id":"925b69b9-f241-4d89-9e3e-208a98dfc8eb","title":"New article 2","public_version":1,"latest_version":1,"language_code":"en","hidden":false,"status":0,"order":2,"slug":"new-article-2","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":"2024-06-13T14:30:00","current_workflow_status_id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086"}],"child_categories":[{"articles":[{"id":"cf8f67da-77c7-48b1-b207-70875caa2f55","title":"New article 3","public_version":1,"latest_version":1,"language_code":"en","hidden":false,"status":0,"order":2,"slug":"new-article-3","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":"2024-06-13T14:30:00","current_workflow_status_id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086"},{"id":"925b69b9-f241-4d89-9e3e-208a98dfc8eb","title":"New article 4","public_version":1,"latest_version":1,"language_code":"en","hidden":false,"status":0,"order":2,"slug":"new-article-4","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":"2024-06-13T14:30:00","current_workflow_status_id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086"}],"child_categories":[],"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","name":"Child category name","description":null,"project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":11,"parent_category_id":null,"hidden":false,"icon":null,"slug":"category-name","language_code":null,"category_type":2,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","status":null,"content_type":null,"current_workflow_status_id":"9fc4dd1a-ee83-489f-994d-ddf43c9b4b18"}],"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","name":"Category name","description":null,"project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":11,"parent_category_id":null,"hidden":false,"icon":null,"slug":"category-name","language_code":null,"category_type":2,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","status":null,"content_type":null,"current_workflow_status_id":"9fc4dd1a-ee83-489f-994d-ddf43c9b4b18"},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Cannot find category with id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Language Not Found": { "summary": "Kindly verify the langCode, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language code not found","error_code":null,"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": [ ] } ] }, "put": { "tags": [ "Categories" ], "summary": "Updates a category with the ID", "description": "Partial update — only fields present in the body are written. Use this for metadata (name, slug, ordering, icon, visibility); use `PUT /v2/categories/{categoryId}/content/{langCode}` for the category's page body content.\r\nIdempotent: replaying the same body produces the same final state.", "operationId": "updateCategory", "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" } ], "requestBody": { "description": "Partial update payload — only the fields present in the request body are updated.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Updating Category": { "summary": "Request for Updating Category Name.\\n if you are not using parent_category_id then remove the field.", "value": {"name":"UpdatedName","order":0,"parent_category_id":"814bd3cc-4cd1-4f97-adde-d4d644e9fe78","hidden":false,"icon":"","language":"en"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Updating Category": { "summary": "Request for Updating Category Name.\\n if you are not using parent_category_id then remove the field.", "value": {"name":"UpdatedName","order":0,"parent_category_id":"814bd3cc-4cd1-4f97-adde-d4d644e9fe78","hidden":false,"icon":"","language":"en"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Updating Category": { "summary": "Request for Updating Category Name.\\n if you are not using parent_category_id then remove the field.", "value": {"name":"UpdatedName","order":0,"parent_category_id":"814bd3cc-4cd1-4f97-adde-d4d644e9fe78","hidden":false,"icon":"","language":"en"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Updating Category": { "summary": "Request for Updating Category Name.\\n if you are not using parent_category_id then remove the field.", "value": {"name":"UpdatedName","order":0,"parent_category_id":"814bd3cc-4cd1-4f97-adde-d4d644e9fe78","hidden":false,"icon":"","language":"en"} } } } }, "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/UpdateCategoryResponse" }, "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"data":{"id":"68212cec-7a9b-4323-9bb8-33865444a508","name":"UpdatedName","order":0,"icon":""},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "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":[]} }, "parent_category_id should be removed if its null or empty..": { "summary": "Kindly remove the parent_category_id, it should not be null or empty. \\n if there you need an parent_category_id with another category please add it.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Object reference not set to an instance of an object.","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": [ ] } ] }, "delete": { "tags": [ "Categories" ], "summary": "Deletes a category with an ID", "description": "Soft delete. **All articles and child categories within this category are also deleted** — cascade behaviour. Confirm with the workspace's owner before bulk-deleting categories.\r\nIdempotent: deleting an already-deleted category returns `404`.", "operationId": "deleteCategory", "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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Successfully Deleted": { "summary": "The category has been successfully deleted.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"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": { "Category not found": { "summary": "Kindly verify the Categotry Id and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","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": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}/settings": { "get": { "tags": [ "Categories" ], "summary": "Gets settings for the category", "operationId": "getCategorySettingsWithLangCode", "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" } ], "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": { "Success Response": { "summary": "Getting settings status for category.", "value": {"data":{"slug":"indexpage","seo_title":"IndexPage","description":null,"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":[],"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":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id and Langauage code, and peroform 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":[]} } } } } }, "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": [ ] } ] }, "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}versions": { "get": { "tags": [ "Categories" ], "summary": "Gets category page versions", "operationId": "getCategoryDataVersionsWithLangCode", "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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryVersionsResponse" }, "examples": { "Success response": { "summary": "Success response for getting category page with version.", "value": {"versions":[{"version_number":1,"created_by":null,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":0,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","version_type":null,"system_backup_ordinal":null}],"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","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": [ ] } ] } }, "/v2/Categories/{categoryId}/content/{langCode}": { "get": { "tags": [ "Categories" ], "summary": "Gets category page content with an ID", "operationId": "getCategoryData", "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" }, { "name": "isForDisplay", "in": "query", "description": "Set to `true` when rendering the category for an end-user — the response will resolve snippet, variable, and glossary merge codes. Do not pass `true` and then send the resolved content to an update endpoint.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "isPublished", "in": "query", "description": "When `true`, returns the latest published version. When `false`, returns the latest draft regardless of publish state.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": 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/GetCategoryContentResponse" }, "examples": { "Success Response": { "summary": "This is an example for get category page succes response. \\n Here you can view diffrent data included with multiple Authors associated with a category page.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication","html_content":"

Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication

\n","block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":1,"enable_rtl":true,"hidden":false,"status":0,"version_type":null,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","user_role":7,"last_login_at":"2024-06-13T14:30:00","unique_user_name":"peter-jone","sso_user_type":0,"is_sso_user":false,"is_active":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"indexpage","is_fall_back_content":true,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "V2 Response (custom_fields_data)": { "summary": "V2 callers receive custom_fields_data instead of custom_fields. Values are in their native type — string, number, boolean. Multi-select fields are returned as a comma-separated string. Fields with no value are included as null.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":null,"html_content":null,"block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":0,"latest_version":0,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"created_by":null,"authors":[],"created_at":"0001-01-01T00:00:00","modified_at":"0001-01-01T00:00:00","slug":null,"is_fall_back_content":false,"stale_status":null,"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields_data":{"Category Type":"Index Page","Display Order":1,"Tags":"Getting Started, Tutorials","Is Featured":false,"Notes":null}},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id, version Number and Langauage code, and peroform 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":[]} }, "Version not found": { "summary": "Kindly verify the version Number and language code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category with Id ad6ef117-1e8f-4817-800b-6ed8e2304bf2 with the language code en does not contain version 2","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": [ ] } ] }, "put": { "tags": [ "Categories" ], "summary": "Updates a category page content with the ID", "operationId": "updateCategoryContent", "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 content update payload — only the fields present in the request body are updated. Do not pass content fetched with `isForDisplay=true`; the resolved merge codes would overwrite the source.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryContentCustomerRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"

This is my updated content,

","block_content":"

This is my updated content,

","version_number":1,"translation_option":"","source":"","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryContentCustomerRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"

This is my updated content,

","block_content":"

This is my updated content,

","version_number":1,"translation_option":"","source":"","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryContentCustomerRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"

This is my updated content,

","block_content":"

This is my updated content,

","version_number":1,"translation_option":"","source":"","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryContentCustomerRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"

This is my updated content,

","block_content":"

This is my updated content,

","version_number":1,"translation_option":"","source":"","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":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/UpdateCategoryContentCustomerResponse" }, "examples": { "Successfully Updated Category": { "summary": "Updated Catgory information is shown in this response.", "value": {"data":{"id":"d6f49c75-1eea-4101-bfd4-fd314f57815d","title":"UpdateTitleForCategoryPage","content":"This is my updated content.","html_content":"

This is my updated content.

\n","block_content":null,"category_id":"d6f49c75-1eea-4101-bfd4-fd314f57815d","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":2,"public_version":1,"latest_version":2,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"order":0,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"updatetitleforcategorypage","is_fall_back_content":false},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "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": [ ] } ] } }, "/v2/Categories/{categoryId}/settings": { "get": { "tags": [ "Categories" ], "summary": "Gets settings for the category", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `GET /v2/categories/{categoryId}/{langCode}/settings`.", "operationId": "getCategorySettings", "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" } ], "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": { "Success Response": { "summary": "Getting settings status for category.", "value": {"data":{"slug":"indexpage","seo_title":"IndexPage","description":null,"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":[],"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":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id and Langauage code, and peroform 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":[]} } } } } }, "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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] }, "put": { "tags": [ "Categories" ], "summary": "Updates settings for the category", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `PUT /v2/categories/{categoryId}/{langCode}/settings`.", "operationId": "updateCategorySettings", "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" } ], "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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": [ ] } ] } }, "/v2/Categories/{categoryId}/versions": { "get": { "tags": [ "Categories" ], "summary": "Gets category page versions", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `GET /v2/categories/{categoryId}/{langCode}versions`.", "operationId": "getCategoryDataVersions", "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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoryVersionsResponse" }, "examples": { "Success response": { "summary": "Success response for getting category page with version.", "value": {"versions":[{"version_number":1,"created_by":null,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":0,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","version_type":null,"system_backup_ordinal":null}],"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/versions/{langCode}/{versionNumber}": { "get": { "tags": [ "Categories" ], "summary": "Gets category page content with an ID", "operationId": "getCategoryDataByVersionWithLangCode", "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": "versionNumber", "in": "path", "description": "Version number of the category. Use `GET /v2/categories/{categoryId}/{langCode}versions` to list versions.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "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" }, { "name": "isForDisplay", "in": "query", "description": "Set to `true` when rendering the category for an end-user — the response will resolve snippet, variable, and glossary merge codes. Do not pass `true` and then send the resolved content to an update endpoint.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": 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/GetCategoryContentResponse" }, "examples": { "Success Response": { "summary": "This is an sample category data by category version.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication","html_content":"

Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication

\n","block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":1,"enable_rtl":true,"hidden":false,"status":0,"version_type":null,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","user_role":7,"last_login_at":"2024-06-13T14:30:00","unique_user_name":"peter-jone","sso_user_type":0,"is_sso_user":false,"is_active":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"indexpage","is_fall_back_content":true,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "V2 Response (custom_fields_data)": { "summary": "V2 callers receive custom_fields_data instead of custom_fields. Values are in their native type — string, number, boolean. Multi-select fields are returned as a comma-separated string. Fields with no value are included as null.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":null,"html_content":null,"block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":0,"latest_version":0,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"created_by":null,"authors":[],"created_at":"0001-01-01T00:00:00","modified_at":"0001-01-01T00:00:00","slug":null,"is_fall_back_content":false,"stale_status":null,"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields_data":{"Category Type":"Index Page","Display Order":1,"Tags":"Getting Started, Tutorials","Is Featured":false,"Notes":null}},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id and Langauage code, and peroform 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":[]} }, "Version not found": { "summary": "Kindly verify the version Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category with Id ad6ef117-1e8f-4817-800b-6ed8e2304bf2 with the language code en does not contain version 2","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": [ ] } ] } }, "/v2/Categories/{categoryId}/versions/{versionNumber}": { "get": { "tags": [ "Categories" ], "summary": "Gets category page content with an ID", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `GET /v2/categories/{categoryId}/versions/{langCode}/{versionNumber}`.", "operationId": "getCategoryDataByVersion", "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": "versionNumber", "in": "path", "description": "Version number of the category. Use `GET /v2/categories/{categoryId}/{langCode}versions` to list versions.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "isForDisplay", "in": "query", "description": "Set to `true` when rendering the category for an end-user — the response will resolve snippet, variable, and glossary merge codes. Do not pass `true` and then send the resolved content to an update endpoint.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": 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/GetCategoryContentResponse" }, "examples": { "Success Response": { "summary": "This is an sample category data by category version.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":"Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication","html_content":"

Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication

\n","block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":1,"latest_version":1,"enable_rtl":true,"hidden":false,"status":0,"version_type":null,"created_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","authors":[{"id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","user_role":7,"last_login_at":"2024-06-13T14:30:00","unique_user_name":"peter-jone","sso_user_type":0,"is_sso_user":false,"is_active":false}],"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","slug":"indexpage","is_fall_back_content":true,"stale_status":{"article_stale_status":0,"stale_reason":"","expired_at":"2024-06-13T14:30:00","is_from_document_settings":false,"expire_days":0},"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields":[{"field_id":"field-definition-id-1","name":"Category Type","type":0,"value":"Index Page"},{"field_id":"field-definition-id-2","name":"Display Order","type":6,"value":1}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "V2 Response (custom_fields_data)": { "summary": "V2 callers receive custom_fields_data instead of custom_fields. Values are in their native type — string, number, boolean. Multi-select fields are returned as a comma-separated string. Fields with no value are included as null.", "value": {"category":{"id":"5b291e6b-fa40-4ab9-941e-f8fffc23b376","title":"IndexPage","content":null,"html_content":null,"block_content":null,"parent_category_id":null,"project_document_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"public_version":0,"latest_version":0,"enable_rtl":false,"hidden":false,"status":0,"version_type":null,"created_by":null,"authors":[],"created_at":"0001-01-01T00:00:00","modified_at":"0001-01-01T00:00:00","slug":null,"is_fall_back_content":false,"stale_status":null,"content_type":"Markdown","current_workflow_status_id":null,"is_block_editor":false,"custom_fields_data":{"Category Type":"Index Page","Display Order":1,"Tags":"Getting Started, Tutorials","Is Featured":false,"Notes":null}},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id and Langauage code, and peroform 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":[]} }, "Version not found": { "summary": "Kindly verify the version Id and Langauage code, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category with Id ad6ef117-1e8f-4817-800b-6ed8e2304bf2 with the language code en does not contain version 2","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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}/publish": { "post": { "tags": [ "Categories" ], "summary": "Publishes a category with an id", "description": "Marks the selected draft version of a Page-type category as the current published version. Folder-type categories cannot be published (they have no content of their own).\r\nIdempotent — publishing an already-published version is a no-op. Use `DELETE /v2/categories/{categoryId}/{langCode}/publish` to unpublish.", "operationId": "publishCategoryWithLangCode", "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": "The publish payload. `versionNumber` selects which draft version to publish; `publishMessage` is an optional changelog note.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } } }, "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/BulkCreateCategoryResponse" }, "examples": { "Successfully Published Category": { "summary": "Category page\t\t", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "CategoryId not found": { "summary": "kindly verify the CategoryId 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":[]} }, "version_number not found": { "summary": "kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id nad perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field 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": [ ] } ] }, "delete": { "tags": [ "Categories" ], "summary": "Unpublishes a category with an id", "operationId": "unpublishCategoryWithLangCode", "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": "Unpublish payload. `versionNumber` selects which published version to unpublish; `unpublishMessage` is an optional changelog note.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Unpublish category Request Example": { "summary": "This is an basic example for unpublish category. ProjectVersionId, UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Successfully unpublished"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Unpublish category Request Example": { "summary": "This is an basic example for unpublish category. ProjectVersionId, UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Successfully unpublished"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Unpublish category Request Example": { "summary": "This is an basic example for unpublish category. ProjectVersionId, UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Successfully unpublished"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UnpublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Unpublish category Request Example": { "summary": "This is an basic example for unpublish category. ProjectVersionId, UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1,"unpublish_message":"Successfully unpublished"} } } } }, "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/BulkCreateCategoryResponse" }, "examples": { "Successfully unpublished category": { "summary": "Unublishing a page category with CategoryId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "CategoryId not found": { "summary": "kindly verify the CategoryId 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":[]} }, "version_number not found": { "summary": "kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id nad perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field 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": [ ] } ] } }, "/v2/Categories/{categoryId}/publish": { "post": { "tags": [ "Categories" ], "summary": "Publishes a category with an id", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `POST /v2/categories/{categoryId}/{langCode}/publish`.", "operationId": "publishCategory", "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" } ], "requestBody": { "description": "The publish payload. `versionNumber` selects which draft version to publish; `publishMessage` is an optional changelog note.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Publish Category Request Example": { "summary": "This is an basic example for publish category. UserId and VersionNumber are mandatory.", "value": {"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Successfully Published"} } } } }, "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/BulkCreateCategoryResponse" }, "examples": { "Successfully Published Category": { "summary": "Category page\t\t", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "CategoryId not found": { "summary": "kindly verify the CategoryId 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":[]} }, "version_number not found": { "summary": "kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id nad perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field 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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/bulkcreate": { "post": { "tags": [ "Categories" ], "summary": "Adds multiple categories", "operationId": "bulkCreateCategory", "requestBody": { "description": "A list of category creation requests. For each category, the `slug` property is optional — if not provided, a slug is auto-generated from the name. When provided, the slug must be unique within the workspace, otherwise an error is returned for that category.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddCategoryRequest" } }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Page.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddCategoryRequest" } }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Page.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddCategoryRequest" } }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Page.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddCategoryRequest" } }, "examples": { "Create a new Category as Folder.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":0,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Page.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null}] }, "Create a new Category as Index.": { "summary": "Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.", "value": [{"name":"New Category 1","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":null},{"name":"New Category 2","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","order":0,"parent_category_id":null,"content":null,"category_type":2,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null,"slug":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/BulkCreateCategoryResponse" }, "examples": { "Update article wth article Id": { "summary": "Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option, and source.", "value": {"data":[{"index":0,"category_id":"b1a857d9-ecbc-4ab3-a0cb-ed22267ec999","lang_code":null,"success":true,"details":"Successfully created category New Category 1"},{"index":0,"category_id":"975a72df-a8b6-4a4e-8081-be9baddd0467","lang_code":null,"success":true,"details":"Successfully created category New Category 2"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "No Category created": { "summary": "Kindly add some data to create category.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Empty project_version_id Parameters": { "summary": "Kindly verify the project_version_id is not empty, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The ProjectVersionId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Invalid Category Name Parameter": { "summary": "Kindly verify the Name, and peroform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Name field 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" } } } }, "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": [ ] } ] } }, "/v2/Categories/bulkpublish/{langCode}": { "post": { "tags": [ "Categories" ], "summary": "Publishes multiple categories", "operationId": "bulkUnpublishCategoriesAlias", "parameters": [ { "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": "Bulk publish payload listing the categories and version numbers to publish.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishCategory" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Published Category Request": { "summary": "Category page has published successfully. the category_id, user_id, and version_number are mandatory.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","user_id":"edr1efc6f-e968-4e95-82eb-ccad61559deef3","version_number":1,"publish_message":"Publish Success"}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishCategory" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Published Category Request": { "summary": "Category page has published successfully. the category_id, user_id, and version_number are mandatory.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","user_id":"edr1efc6f-e968-4e95-82eb-ccad61559deef3","version_number":1,"publish_message":"Publish Success"}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishCategory" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Published Category Request": { "summary": "Category page has published successfully. the category_id, user_id, and version_number are mandatory.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","user_id":"edr1efc6f-e968-4e95-82eb-ccad61559deef3","version_number":1,"publish_message":"Publish Success"}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkPublishCategory" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Published Category Request": { "summary": "Category page has published successfully. the category_id, user_id, and version_number are mandatory.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","version_number":1,"publish_message":"Publish Success"},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","user_id":"edr1efc6f-e968-4e95-82eb-ccad61559deef3","version_number":1,"publish_message":"Publish Success"}] } } } }, "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/BulkPublishCategoryResponse" }, "examples": { "Successfully Published Category": { "summary": "Category page\t\t", "value": {"data":[{"index":0,"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","lang_code":null,"success":true,"details":"Bulk Publish Success"},{"index":0,"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","lang_code":null,"success":true,"details":"Bulk Publish Success"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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_id not found": { "summary": "Kindly verify the category_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The CategoryId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "Kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","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": [ ] } ] }, "delete": { "tags": [ "Categories" ], "summary": "Unpublishes multiple categories", "operationId": "bulkUnpublishCategoriesAlias", "parameters": [ { "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": "Bulk unpublish payload listing the categories and version numbers to unpublish.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Unpublished category request": { "summary": "Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.", "value": {"categories":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","version_number":1},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"Unpublish category"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Unpublished category request": { "summary": "Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.", "value": {"categories":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","version_number":1},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"Unpublish category"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Unpublished category request": { "summary": "Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.", "value": {"categories":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","version_number":1},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"Unpublish category"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/BulkUnpublishCategoryRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Unpublished category request": { "summary": "Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.", "value": {"categories":[{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","version_number":1},{"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","version_number":1}],"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","unpublish_message":"Unpublish category"} } } } }, "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/BulkUnpublishCategoryResponse" }, "examples": { "Successfully Unublished Category": { "summary": "Unublishing a page category with CategoryId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.", "value": {"data":[{"index":0,"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6s","lang_code":null,"success":true,"details":"Successfully unpublished category with an id 152e9239-1a5a-4044-b5de-1030f49976b6s"},{"index":0,"category_id":"gr32e9239-1a5a-4044-b5de-1030f499fe6sr","lang_code":null,"success":true,"details":"Successfully unpublished category with an id gr32e9239-1a5a-4044-b5de-1030f499fe6sr"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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_id not found": { "summary": "Kindly verify the category_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The CategoryId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "user_id not found": { "summary": "Kindly verify the user_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The UserId field is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "version_number not found": { "summary": "Kindly verify the version_number and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The field VersionNumber must be between 1 and 32767.","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": [ ] } ] } }, "/v2/Categories/update-workflow": { "post": { "tags": [ "Categories" ], "summary": "Update workflow status of the categories", "operationId": "updateCategoryWorkflowStatus", "requestBody": { "description": "Workflow update payload. `projectVersionId` identifies the workspace, `categoryIds` lists the affected categories, and `workflowStatusInfo` carries the new status, assignee, and due date.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryWorkflowStatusRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","category_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryWorkflowStatusRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","category_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryWorkflowStatusRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","category_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateCategoryWorkflowStatusRequest" } ] }, "example": {"project_version_id":"ae430990-88df-4886-b1e6-2596ae416df7","lang_code":"en","user_id":"43340990-88df-4886-b1e6-2596ae416df7","category_ids":["ea35f84c-394b-407c-80e9-4187a7ea9620","49fe8b58-2e21-4251-b10d-cec4c5a8769f"],"workflow_status_info":{"status_id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","due_date":"2024-06-13T14:30:00","comment":"Ready for review","assignee_id":"eed92685-0c5e-46b4-b559-c27625fe7a6b"}} } }, "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/CustomerApiBaseResponse" }, "examples": { "Update Workflow - 200 Success response.": { "summary": "The below example shows a successful workflow update response", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Missing ProjectDocumentVersionId": { "summary": "The 'ProjectDocumentVersionId' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"ProjectDocumentVersion ID is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing LangCode": { "summary": "The 'LangCode' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language code is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing UserId": { "summary": "The 'UserId' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"User Id is required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing DocumentIds": { "summary": "The 'DocumentIds' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Document IDs are required.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Missing WorkflowStatusInfo": { "summary": "The 'WorkflowStatusInfo' field is required but was not provided.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Workflow status information 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" } } } }, "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": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}/updateDescription": { "put": { "tags": [ "Categories" ], "summary": "Updates the category description", "operationId": "updateCategoryDescriptionWithLangCode", "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": "description", "in": "query", "description": "The new description for the category (maximum 250 characters).", "schema": { "maxLength": 250, "type": "string" }, "example": "Step-by-step guide to wiring up Okta SSO." }, { "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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category description updated": { "summary": "The category description was updated. `success` is `true`; the envelope carries no `result` payload for this endpoint.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 Id not found": { "summary": "Kindly update the Category Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "LangCode not found": { "summary": "The supplied `langCode` is not enabled for the workspace. Use `GET /v2/language/{projectVersionId}` to list valid codes.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language 'de-DE' is not enabled for this workspace.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Description missing": { "summary": "The request body did not include a `description` value (or it was empty).", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The description field is required.","error_code":null,"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": [ ] } ] } }, "/v2/Categories/{categoryId}/fork": { "put": { "tags": [ "Categories" ], "summary": "Forks a category page with an id", "operationId": "forkCategoryVersion", "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" } ], "requestBody": { "description": "Fork payload — `versionNumber` selects the source version, `langCode` selects the translation (defaults to `en`), and `userId` records the author.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkCategoryVersionRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"version_number":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkCategoryVersionRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"version_number":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkCategoryVersionRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"version_number":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ForkCategoryVersionRequest" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"version_number":1,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","lang_code":"en"} } } } }, "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/ForkCategoryVersionResponse" }, "examples": { "Fork category page with Id": { "summary": "Fork category page with current version_number, user_id and lang_code.", "value": {"data":{"version_number":2,"created_by":"peter jone","created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","base_version":1,"status":0,"profile_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E","version_type":null,"system_backup_ordinal":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": "Category page not found in the context. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "UserId not found": { "summary": "UserId not found in the context. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de' does not exist in your project.","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "Version Number not found": { "summary": "Version Number not found in the context. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Cannot fork version number 5, it does not exist in your project","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "LangCode not found": { "summary": "LangCode is missing in the Request Body. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The LangCode field is required.","error_code":"","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": [ ] } ] } }, "/v2/Categories/{categoryId}/updateCategoryType": { "put": { "tags": [ "Categories" ], "summary": "Updates the category type", "operationId": "updateCategoryType", "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": "categoryType", "in": "query", "description": "Category type — `0` Folder, `1` Page, `2` Index.", "required": true, "schema": { "enum": [ "default", "customContent", "linksToArticle" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "Defines what a category represents in the documentation hierarchy.", "x-enumNames": [ "Default", "CustomContent", "LinksToArticle" ], "x-enum-varnames": [ "Default", "CustomContent", "LinksToArticle" ], "x-ms-enum": { "name": "CategoryType", "modelAsString": true } } }, { "name": "userId", "in": "query", "description": "The ID of the team account performing the action. Fetch via `GET /v2/teams`.", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category type Updated Successfully": { "summary": "Updated the category type. Status updated successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "CategoryId not found": { "summary": "Kindly update the category Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"warnings":[],"information":[]} }, "userId not found": { "summary": "Kindly update the user Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] } }, "/v2/Categories/{categoryId}/updateDescription": { "put": { "tags": [ "Categories" ], "summary": "Updates the category description", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `PUT /v2/categories/{categoryId}/{langCode}/updateDescription`.", "operationId": "updateCategoryDescription", "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": "description", "in": "query", "description": "The new description for the category (maximum 250 characters).", "schema": { "maxLength": 250, "type": "string" }, "example": "Step-by-step guide to wiring up Okta SSO." } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Category description updated": { "summary": "The category description was updated. `success` is `true`; the envelope carries no `result` payload for this endpoint.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 Id not found": { "summary": "Kindly update the Category Id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Category not found","error_code":"","custom_data":null}],"warnings":[],"information":[]} }, "LangCode not found": { "summary": "The supplied `langCode` is not enabled for the workspace. Use `GET /v2/language/{projectVersionId}` to list valid codes.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language 'de-DE' is not enabled for this workspace.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Description missing": { "summary": "The request body did not include a `description` value (or it was empty).", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The description field is required.","error_code":null,"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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/bulkupdateContent": { "put": { "tags": [ "Categories" ], "summary": "Updates multiple category page contents", "operationId": "bulkUpdateCategoryContent", "requestBody": { "description": "Bulk content update payload. Each entry is a partial category content update — only the fields present in each entry are updated.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryContentRequest" } }, "examples": { "Update multiple page category ": { "summary": "Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","title":"New Name","content":"No new content","html_content":"

No new content

","block_content":"

No new content

","version_number":2,"translation_option":null,"source":null,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null}] } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryContentRequest" } }, "examples": { "Update multiple page category ": { "summary": "Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","title":"New Name","content":"No new content","html_content":"

No new content

","block_content":"

No new content

","version_number":2,"translation_option":null,"source":null,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null}] } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryContentRequest" } }, "examples": { "Update multiple page category ": { "summary": "Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","title":"New Name","content":"No new content","html_content":"

No new content

","block_content":"

No new content

","version_number":2,"translation_option":null,"source":null,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":null}] } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateCategoryContentRequest" } }, "examples": { "Update multiple page category ": { "summary": "Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.", "value": [{"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","title":"New Name","content":"No new content","html_content":"

No new content

","block_content":"

No new content

","version_number":2,"translation_option":null,"source":null,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","content_type":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/BulkUpdateCategoryContentResponse" }, "examples": { "Bulk Update Successful": { "summary": "You can find all the updated Category page details below.", "value": {"data":[{"index":0,"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"en","success":true,"details":"Successfully updated category with an id 152e9239-1a5a-4044-b5de-1030f49976b6"},{"index":1,"category_id":"152e9239-1a5a-4044-b5de-1030f49976b6","lang_code":"fr","success":false,"details":"Failed to update category with an id 152e9239-1a5a-4044-b5de-1030f49976b6\nError: Category not found for the specified language."}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": "The enhtered categoryId is not valid. Kindly verify the categoryId and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to update category with an id 152e9239-1a5a-044-b5de-103f49976b6\r\nError: Category not found' does not exist in your project.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "UserId not Found": { "summary": "The user_id is not found. kindly verify the updated_by (user id) from /V2/Teams Get Method", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to update category with an id 152e9239-1a5a-4044-b5de-1030f49976b6\r\nError: The user with id '6f-e968-4e95-82eb-85ad61559de8' does not exist in your project.","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/Categories/{categoryId}/{langCode}/version/{versionNumber}": { "delete": { "tags": [ "Categories" ], "summary": "Deletes a category version", "operationId": "deleteCategoryVersionWithLangCode", "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": "versionNumber", "in": "path", "description": "Version number of the category. Use `GET /v2/categories/{categoryId}/{langCode}versions` to list versions.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "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" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Successfully Deleted": { "summary": "The category version has been successfully deleted.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid CategoryId","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version not found": { "summary": "Kindly verify the version and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Last Version cannot be deleted","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version number invalid": { "summary": "Kindly verify the version number and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Category Version","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": [ ] } ] } }, "/v2/Categories/{categoryId}/version/{versionNumber}": { "delete": { "tags": [ "Categories" ], "summary": "Deletes a category version", "description": "This endpoint defaults the language to `en`. Prefer the language-aware variant `DELETE /v2/categories/{categoryId}/{langCode}/version/{versionNumber}`.", "operationId": "deleteCategoryVersion", "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": "versionNumber", "in": "path", "description": "Version number of the category. Use `GET /v2/categories/{categoryId}/{langCode}versions` to list versions.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Successfully Deleted": { "summary": "The category version has been successfully deleted.", "value": {"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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 verify the Categotry Id and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid CategoryId","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version not found": { "summary": "Kindly verify the version and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Last Version cannot be deleted","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Version number invalid": { "summary": "Kindly verify the version number and Langauage code, then peroform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Category Version","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" } } } } }, "deprecated": true, "security": [ { "api_token": [ ] } ] } }, "/v2/Categories/bulkdelete-category-versions": { "delete": { "tags": [ "Categories" ], "summary": "Delete multiple category versions", "operationId": "bulkDeleteCategoryVersions", "parameters": [ { "name": "categoryId", "in": "query", "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": "query", "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.", "required": true, "schema": { "type": "string" }, "example": "en" }, { "name": "categoryVersionNumbers", "in": "query", "description": "Array of category version numbers to delete. Use `GET /v2/categories/{categoryId}/{langCode}versions` to list versions.", "required": true, "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteCategoryVersionResponse" } } } }, "401": { "description": "Authentication failed — the `api_token` header is missing, malformed, or has been revoked.", "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": [ ] } ] } }, "/v2/customfields": { "get": { "tags": [ "CustomField" ], "summary": "Gets all custom field definitions.", "description": "This endpoint returns metadata about all custom fields configured for your project.\r\nUse this information to understand available fields before updating article settings.", "operationId": "getCustomFieldDefinitions", "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomFieldDefinitionsResponse" }, "examples": { "Success Response": { "summary": "This response shows all custom field definitions available for the project. Use the field names and metadata to construct update requests.", "value": {"data":[{"field_id":"field-definition-id-1","name":"Country","type":0,"placeholder":"Enter country name","help_text":"The country where this article applies","max_length":100},{"field_id":"field-definition-id-2","name":"Priority","type":6,"placeholder":"Enter priority","help_text":"Priority level (1=lowest, 10=highest)"},{"field_id":"field-definition-id-3","name":"Status","type":2,"placeholder":"Select status","help_text":"Current article status","options":[{"id":"option-id-active","label":"Active"},{"id":"option-id-inactive","label":"Inactive"}]}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Invalid Project": { "summary": "This error occurs when the project ID is invalid or custom fields feature is not enabled.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Custom fields feature is not enabled for this project","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" } } } }, "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": [ ] } ] } }, "/v2/Drive/Folders": { "get": { "tags": [ "Drive" ], "summary": "Gets folders information", "operationId": "getFolders", "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaFolderResponseCustomer" }, "examples": { "Success status response": { "summary": "Here, you can verify the folder’s information.", "value": {"data":[{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","title":"Document","parent_folder_id":"fsf41c-0f94-4b04-a8b6-a14bb1995eca","sub_folders":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","title":"Images","parent_folder_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","sub_folders":[],"items_count":0,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","created_at":null,"updated_on":"2024-06-13T14:30:00","order":2,"is_starred":true,"folder_color":null}],"items_count":1,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","created_at":null,"updated_on":"2024-06-13T14:30:00","order":1,"is_starred":true,"folder_color":null}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad Response": { "summary": "Kindly verify the given folder is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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" } } } }, "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": [ ] } ] }, "post": { "tags": [ "Drive" ], "summary": "Adds a new folder to Drive", "operationId": "addFolders", "requestBody": { "description": "Folder creation payload. `title` is required; `parentFolderId` places the folder as a child of an existing folder (omit for a root-level folder — fetch via `GET /v2/drive/Folders`); `userId` records the author (fetch via `GET /v2/teams`).", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddMediaFolderRequestCustomer" } ] }, "examples": { "Add media folder": { "summary": "Request body for adding folder with parentfolderId, name and order.", "value": {"title":"Title","parent_folder_id":"d8b65d24-ce62-407a-8463-846efc8eee93","user_id":"ffb65d24-ce62-407a-84d-8dfdfefc8eee93","order":1} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddMediaFolderRequestCustomer" } ] }, "examples": { "Add media folder": { "summary": "Request body for adding folder with parentfolderId, name and order.", "value": {"title":"Title","parent_folder_id":"d8b65d24-ce62-407a-8463-846efc8eee93","user_id":"ffb65d24-ce62-407a-84d-8dfdfefc8eee93","order":1} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddMediaFolderRequestCustomer" } ] }, "examples": { "Add media folder": { "summary": "Request body for adding folder with parentfolderId, name and order.", "value": {"title":"Title","parent_folder_id":"d8b65d24-ce62-407a-8463-846efc8eee93","user_id":"ffb65d24-ce62-407a-84d-8dfdfefc8eee93","order":1} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddMediaFolderRequestCustomer" } ] }, "examples": { "Add media folder": { "summary": "Request body for adding folder with parentfolderId, name and order.", "value": {"title":"Title","parent_folder_id":"d8b65d24-ce62-407a-8463-846efc8eee93","user_id":"ffb65d24-ce62-407a-84d-8dfdfefc8eee93","order":1} } } } }, "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/MediaFolderMetaDataResponseCustomer" }, "examples": { "Bad Response": { "summary": "The folder has been created successfully.", "value": {"data":{"media_folder_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","media_folder_title":"Folder Title","order":1,"icon":null,"updated_on":"2024-06-13T14:30:00","folder_color":null,"is_starred":true,"updated_by":"fdsc041c-0f94-4b04-a8b6-a14bb1995eca","parent_media_folder_id":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad Response": { "summary": "Kindly check your folder credentials and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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" } } } }, "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": [ ] } ] }, "put": { "tags": [ "Drive" ], "summary": "Updates a folder with ID", "operationId": "updateFolder", "parameters": [ { "name": "folderId", "in": "query", "description": "The ID of the Drive folder. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" } ], "requestBody": { "description": "Partial folder update payload. Only `name`, `folderColor`, `isStarred`, and `order` are honored.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaFolderRequestCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Update media folder": { "summary": "Request body for updating folder with name,order,folder color and IsStarred. ", "value": {"name":"Updated folder name","order":2,"folder_color":"#8852F5","is_starred":true} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaFolderRequestCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Update media folder": { "summary": "Request body for updating folder with name,order,folder color and IsStarred. ", "value": {"name":"Updated folder name","order":2,"folder_color":"#8852F5","is_starred":true} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaFolderRequestCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Update media folder": { "summary": "Request body for updating folder with name,order,folder color and IsStarred. ", "value": {"name":"Updated folder name","order":2,"folder_color":"#8852F5","is_starred":true} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateMediaFolderRequestCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Update media folder": { "summary": "Request body for updating folder with name,order,folder color and IsStarred. ", "value": {"name":"Updated folder name","order":2,"folder_color":"#8852F5","is_starred":true} } } } }, "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/MediaFolderMetaDataResponseCustomer" }, "examples": { "Bad Response": { "summary": "This response indicates the folder has been updated successfully.", "value": {"data":{"media_folder_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","media_folder_title":"Folder Title","order":1,"icon":null,"updated_on":"2024-06-13T14:30:00","folder_color":null,"is_starred":true,"updated_by":"fdsc041c-0f94-4b04-a8b6-a14bb1995eca","parent_media_folder_id":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad Response": { "summary": "Kindly verify the folder ID and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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" } } } }, "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": [ ] } ] } }, "/v2/Drive/Folders/{folderId}": { "get": { "tags": [ "Drive" ], "summary": "Gets folder information by folder ID", "operationId": "getMediaFolderInfo", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the folder in Drive. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": false }, "example": true }, { "name": "pageNo", "in": "query", "description": "0-based page index. Defaults to 0 (first page).", "schema": { "type": "integer", "format": "int32", "default": 0 }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items per page. Defaults to 20.", "schema": { "type": "integer", "format": "int32", "default": 20 }, "example": 20 } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMediaFolderWithIdCustomer" }, "examples": { "Success status response": { "summary": "Here, you can verify the folder’s information using the folder ID.", "value": {"data":{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","title":"Document","order":1,"parent_folder_id":null,"files":[{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","file_name":"New-Image","file_type":"Other","file_url":"https://file.example.com/new-image.jpg","updated_on":"2024-06-13T14:30:00","updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","size":"235","height":null,"width":null,"title":null,"alternative_text":null,"thumbnail_url":null,"tags":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","tag_name":"new-tag"}],"is_starred":true}],"icon":null,"items_count":1,"updated_on":"2024-06-13T14:30:00","updated_by":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","is_starred":false,"folder_color":null,"files_count":1,"sub_folders":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","title":"Images","parent_folder_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","sub_folders":[],"items_count":0,"updated_by":"f11efc6f-e968-4e95-82eb-85ad61559de8","created_at":null,"updated_on":"2024-06-13T14:30:00","order":2,"is_starred":true,"folder_color":null}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad response": { "summary": "Kindly verify the given folder ID is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] }, "delete": { "tags": [ "Drive" ], "summary": "Deletes a folder", "operationId": "deleteFolder", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the folder in Drive. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Success status response": { "summary": "A folder has been deleted successfully.The folder cannot be retrieved or undo.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Deleted folder 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": { "Bad Response": { "summary": "Kindly verify the folder and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] } }, "/v2/Drive/Folders/{folderId}/{fileId}": { "get": { "tags": [ "Drive" ], "summary": "Gets file information", "operationId": "getMediaFileDetails", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the Drive folder. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" }, { "name": "fileId", "in": "path", "description": "The ID of the file. Fetch via `GET /v2/drive/Folders/{folderId}`.", "required": true, "schema": { "type": "string" }, "example": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d" }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": false }, "example": 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/MediaFileAndTagsMetaDataResponseCustomer" }, "examples": { "Success status response": { "summary": "Here, you can verify the file’s information.", "value": {"data":{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","file_name":"New-Image","file_type":"Other","file_url":"https://file.example.com/new-image.jpg","updated_on":"2024-06-13T14:30:00","updated_by":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","size":"235","height":null,"width":null,"parent_folder_id":null,"title":"Document","alternative_text":null,"tags":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","tag_name":"new-tag"}],"thumbnail_url":"https://file.example.com/New-thumbnail-url","is_starred":true},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad Response": { "summary": "Kindly verify the given file is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] }, "put": { "tags": [ "Drive" ], "summary": "Moves a file with file ID", "operationId": "updateFile", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the target folder. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" }, { "name": "fileId", "in": "path", "description": "The ID of the file to move. Fetch via `GET /v2/drive/Folders/{folderId}`.", "required": true, "schema": { "type": "string" }, "example": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Success status response": { "summary": "This status indicates a file has been moved successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"File has been moved 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": { "Bad Response": { "summary": "Kindly verify the given file is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] }, "delete": { "tags": [ "Drive" ], "summary": "Deletes a file using file ID", "description": "Deletion is asynchronous. The response carries a `taskId` you can poll with `GET /v2/drive/Folders/DeleteFile/Status/{taskId}` to track completion.", "operationId": "deleteFiles", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the folder in Drive. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" }, { "name": "fileId", "in": "path", "description": "The ID of the file in Drive. Fetch via `GET /v2/drive/Folders/{folderId}`.", "required": true, "schema": { "type": "string" }, "example": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMediaFileResponseCustomer" }, "examples": { "Success status response": { "summary": "A file has been deleted successfully.The file cannot be retrieved or undo.", "value": {"task_id":"65868a00c536f34594713fec","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad Response": { "summary": "Kindly verify the file and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] } }, "/v2/Drive/Folders/DeleteFile/Status/{taskId}": { "get": { "tags": [ "Drive" ], "summary": "Gets the status of a delete-file operation", "operationId": "getTaskStatus", "parameters": [ { "name": "taskId", "in": "path", "description": "The task ID returned by `DELETE /v2/drive/Folders/{folderId}/{fileId}`.", "required": true, "schema": { "type": "string" }, "example": "b2c3d4e5-f6a7-4b8c-9d0e-a1b2c3d4e5f6" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCustomerTaskStatusResponse" }, "examples": { "Success status response": { "summary": "This example shows the status response for deleting a file operation that has been completed.", "value": {"task_status":{"task_id":"65868a00c536f34594713fec","is_complete":true,"status":2},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad response": { "summary": "This example shows that the given status is invalid. Perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] } }, "/v2/Drive/MediaFiles/{projectVersionId}/{articleId}/{langCode}": { "get": { "tags": [ "Drive" ], "summary": "Gets all media files inserted in the article", "operationId": "getMediaFilesInArticle", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`.", "required": true, "schema": { "type": "string" }, "example": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234" }, { "name": "articleId", "in": "path", "description": "The ID of the article. Fetch via `GET /v2/projectversions/{projectVersionId}/articles`.", "required": true, "schema": { "type": "string" }, "example": "a1096061-e842-41fd-9085-494095e401b9" }, { "name": "langCode", "in": "path", "description": "Language code of the article translation (for example `en`, `fr`, `de-DE`, `pt-BR`). Use `GET /v2/language/{projectVersionId}` to list the codes enabled for a workspace.", "required": true, "schema": { "type": "string" }, "example": "en" }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": false }, "example": 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/GetDriveFilesInArticleDataCustomer" }, "examples": { "Success status response": { "summary": "This is a sample success status response.", "value": {"article_id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","file_urls":["https://file.example.com/new-image.jpg","https://file.example.com/sample-image.jpg"],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad Response": { "summary": "Kindly verify your media files and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[],"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": [ ] } ] } }, "/v2/Drive/Search": { "get": { "tags": [ "Drive" ], "summary": "Searches Drive — files and folders", "operationId": "searchInDrive", "parameters": [ { "name": "searchKeyword", "in": "query", "description": "Keyword to match against file and folder names.", "schema": { "type": "string" }, "example": "hero-image" }, { "name": "pageNo", "in": "query", "description": "0-based page index. Defaults to 0 (first page).", "schema": { "type": "integer", "format": "int32", "default": 0 }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of items per page. Defaults to 20.", "schema": { "type": "integer", "format": "int32", "default": 20 }, "example": 20 }, { "name": "allowImagesOnly", "in": "query", "description": "When `true`, restricts results to image files.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "userIds", "in": "query", "description": "Filter by uploader team-account IDs. Fetch via `GET /v2/teams`.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "filterFromDate", "in": "query", "description": "Filter to items modified on or after this date (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "filterToDate", "in": "query", "description": "Filter to items modified on or before this date (inclusive).", "schema": { "type": "string", "format": "date-time" } }, { "name": "filterTags", "in": "query", "description": "Filter by tag IDs.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllFilesWithCountResponseCustomer" }, "examples": { "Bad Response": { "summary": "This response indicates the process has been completed.", "value": {"data":{"all_files":[{"id":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","file_name":"File name","file_type":"Other","file_url":"https://file.example.com/file.png","updated_on":"2024-06-13T14:30:00","updated_by":"ff9c041c-0f94-4b04-a8b6-a14bb1995eca","size":"342","height":null,"width":null,"title":"File title","alternative_text":null,"is_starred":false,"parent_folder_id":"sdfs041c-0f94-4b04-a8b6-a14bb19fwefver","tag_ids":["e79c041c-0f94-4b04-a8b6-a14bb1995eca","f79c041c-0f94-4b04-a8b6-a14bb1995eca"]}],"count":12},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad Response": { "summary": "Kindly verify the status and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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" } } } }, "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": [ ] } ] } }, "/v2/Drive/Folders/{folderId}/{fileId}/Copy": { "post": { "tags": [ "Drive" ], "summary": "Copies a file from one folder to another", "operationId": "copyFileAndFolder", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the target folder. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" }, { "name": "fileId", "in": "path", "description": "The ID of the file to copy. Fetch via `GET /v2/drive/Folders/{folderId}`.", "required": true, "schema": { "type": "string" }, "example": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Success status response": { "summary": "This response indicates that a file has been successfully copied from one folder to another.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"File has been copied 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": { "Bad Response": { "summary": "Kindly check your folder credentials and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] } }, "/v2/Drive/Folders/{folderId}/{fileId}/Tags": { "post": { "tags": [ "Drive" ], "summary": "Adds tags to a file using file ID", "operationId": "addFileTags", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the Drive folder. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" }, { "name": "fileId", "in": "path", "description": "The ID of the file. Fetch via `GET /v2/drive/Folders/{folderId}`.", "required": true, "schema": { "type": "string" }, "example": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d" }, { "name": "userId", "in": "query", "description": "The ID of the team account performing the action. Fetch via `GET /v2/teams`.", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "requestBody": { "description": "List of tag names to add.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

" }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

" }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

" }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

" } }, "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/MediaFileDataResponseCustomer" }, "examples": { "Success status response": { "summary": "The tags have been added.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Tags added to the file 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": { "Bad Response": { "summary": "Kindly verify your tags are valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] } }, "/v2/Drive/Folders/{folderId}/{fileId}/Tags/Bulkdelete": { "post": { "tags": [ "Drive" ], "summary": "Deletes tags from a file", "operationId": "deleteTagsInFiles", "parameters": [ { "name": "folderId", "in": "path", "description": "The ID of the Drive folder. Fetch via `GET /v2/drive/Folders`.", "required": true, "schema": { "type": "string" }, "example": "c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5" }, { "name": "fileId", "in": "path", "description": "The ID of the file. Fetch via `GET /v2/drive/Folders/{folderId}`.", "required": true, "schema": { "type": "string" }, "example": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d" }, { "name": "userId", "in": "query", "description": "The ID of the team account performing the action. Fetch via `GET /v2/teams`.", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "requestBody": { "description": "List of tag IDs to remove.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

" }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

" }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

" }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

" } }, "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/MediaFileDataResponseCustomer" }, "examples": { "Success status response": { "summary": "This states that tags have been deleted successfully.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"Tags deleted from the file 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": { "Bad Response": { "summary": "Kindly verify your tags are valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] } }, "/v2/Drive/Folders/Files": { "post": { "tags": [ "Drive" ], "summary": "Adds files to Drive", "operationId": "addFiles", "parameters": [ { "name": "DriveFolderId", "in": "query", "description": "The folder ID", "required": true, "schema": { "type": "string" } }, { "name": "UserId", "in": "query", "description": "The ID of the team account", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "files" ], "type": "object", "properties": { "files": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "File collection -The maximum file size upload limit is 40MB" } } }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "encoding": { "files": { "style": "form" } } } } }, "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMediaFileResponseCustomer" }, "examples": { "Success status response": { "summary": "This response indicates that the files were added to the drive successfully.", "value": {"data":[{"id":"d8b65d24-ce62-407a-8463-846efc8eee93","title":"Title name","file_name":"File name","file_type":"Other","file_url":"https://file.example.com/file.png","updated_by":"d79c041c-0f94-4b04-a8b6-a14bb1995eca","media_folder_id":null}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Bad Response": { "summary": "Ensure the given file is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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" } } } }, "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": [ ] } ] } }, "/v2/Language/{projectVersionId}": { "get": { "tags": [ "Language" ], "summary": "Gets all languages configured for a workspace", "operationId": "getLanguage", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`.", "required": true, "schema": { "type": "string" }, "example": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLanguageFromProjectVersion" }, "examples": { "Language versions in a project": { "summary": "This is the enabled language versions for the following project.", "value": {"data":[{"language_id":"850668e5-cbf6-4522-850668e5-cbf6-4522","language_code":"en","language_name":"English","is_set_as_default":true,"country_flag_code":null},{"language_id":"850634e-a748-4522-850668e5-cbf6-4522","language_code":"zh","language_name":"Chinese","is_set_as_default":false,"country_flag_code":null},{"language_id":"850668e5-cbf6-4522-8534e-a748-4522","language_code":"nl","language_name":"Dutch","is_set_as_default":false,"country_flag_code":null}],"extension_data":null,"success":true,"errors":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": [ ] } ] } }, "/v2/Project/Document": { "get": { "tags": [ "Project" ], "summary": "Gets a document (article or category) by URL path", "operationId": "getDocumentByUrl", "parameters": [ { "name": "url", "in": "query", "description": "The relative URL path (for example `/workspace/docs/en/document-slug`).", "required": true, "schema": { "type": "string" }, "example": "/v1/docs/en/getting-started" }, { "name": "redirectionMode", "in": "query", "description": "How the API handles redirection when a redirection rule is configured for the requested resource.\r\n- `0` None — returns the originally requested resource without applying any redirection.\r\n- `1` RedirectOnly — returns an HTTP 302 with the redirected URL, without fetching its content.\r\n- `2` RedirectWithContent — follows the redirection and returns the final resource's content.", "schema": { "enum": [ "none", "redirectOnly", "redirectWithContent" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RedirectionMode" } ], "description": "Possible values: `\"none\"` = None, `\"redirectOnly\"` = RedirectOnly, `\"redirectWithContent\"` = RedirectWithContent", "default": 0, "x-enumNames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-enum-varnames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-ms-enum": { "name": "RedirectionMode", "modelAsString": true } } }, { "name": "isForDisplay", "in": "query", "description": "Set to `true` when rendering the document for an end-user — the response will resolve snippet, variable, and glossary merge codes.", "schema": { "type": "boolean", "default": true }, "example": false }, { "name": "isPublished", "in": "query", "description": "When `true`, returns the latest published version. When `false`, returns the latest draft.", "schema": { "type": "boolean", "default": true }, "example": false }, { "name": "appendSASToken", "in": "query", "description": "Set to `false` to skip appending a SAS token to image/file URLs. SAS tokens are required for private/mixed projects.", "schema": { "type": "boolean", "default": true }, "example": true } ], "responses": { "200": { "description": "Document retrieved successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentByPathResponseCustomer" } } } }, "302": { "description": "Document has been redirected to a new URL.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "400": { "description": "Bad request — malformed URL or missing required segments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","error_code":"400","custom_data":null}],"warnings":[],"information":[]} } } } } }, "404": { "description": "Document not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","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" } } } }, "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": [ ] } ] } }, "/v2/Project/Export/{exportId}": { "get": { "tags": [ "Project" ], "summary": "Gets the status of an export", "operationId": "export", "parameters": [ { "name": "exportId", "in": "path", "description": "The export task ID returned by `POST /v2/project/Export`.", "required": true, "schema": { "type": "string" }, "example": "c8d9e0f1-a2b3-4c4d-e5f6-a7b8c9d0e1f2" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportDocumentationStatusResponse" }, "examples": { "Export Documentation - success Status response": { "summary": "The below example shows the status response for export documentation has successfully Completed.", "value": {"status":"Completed","download_url":"https://document.com//exp/.zip","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Export Documentation - 400 Status response.": { "summary": "The below example shows that the given exportId is Invalid. Track your export Id form /v2/Project/Export.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid export id","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": [ ] } ] } }, "/v2/Project/Import/{importId}": { "get": { "tags": [ "Project" ], "summary": "Gets the status of an import", "operationId": "import", "parameters": [ { "name": "importId", "in": "path", "description": "The import task ID returned by `POST /v2/project/Import`.", "required": true, "schema": { "type": "string" }, "example": "c8d9e0f1-a2b3-4c4d-e5f6-a7b8c9d0e1f2" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDocumentationStatusResponse" }, "examples": { "Import completed": { "summary": "The import task finished successfully. `status` is `Completed` and `importDocumentationLog` is populated.", "value": {"import_documentation_log":null,"status":"Completed","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Import in progress": { "summary": "The import task is still running. Poll again in a few seconds. `status` is `InProgress` and the log is not yet available.", "value": {"import_documentation_log":null,"status":"InProgress","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Invalid import id": { "summary": "The supplied `importId` is not recognised. Use the `id` returned from `POST /v2/project/Import`.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid import id","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": [ ] } ] } }, "/v2/Project/Schemes": { "get": { "tags": [ "Project" ], "summary": "Gets all SSO schemes configured for the project", "operationId": "getAllSchemes", "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSchemeReponse" }, "examples": { "SSO schemes configured": { "summary": "The project has two SSO schemes configured.", "value": {"schemes":[{"id":"1","sso_name":"SSO1","project_id":"1","scheme_name":"Scheme1","display_name":"Scheme1"},{"id":"2","sso_name":"SSO2","project_id":"1","scheme_name":"Scheme2","display_name":"Scheme2"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "No SSO schemes configured": { "summary": "The project has no SSO schemes — `schemes` is an empty array. `success` is still `true`.", "value": {"schemes":[],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Failed to fetch SSO schemes": { "summary": "The schemes could not be retrieved (e.g. transient backend error). `success` is `false`.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"No schemes found for the project.","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" } } } }, "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": [ ] } ] } }, "/v2/Project/workflow-statuses": { "get": { "tags": [ "Project" ], "summary": "Gets all workflow statuses for a project", "operationId": "getWorkflowStatusesByProjectId", "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkflowStatusResponse" }, "examples": { "Get Workflow Statuses - 200 Success response.": { "summary": "The below example shows a successful response with workflow statuses for the project.", "value": {"data":[{"id":"6ea2c8d5-1c81-4981-8ed3-d41b1fc5ab7d","name":"Draft","description":"Initial draft status for new items","read_only":false,"make_comment_mandatory":false},{"id":"65545e06-8c41-4e1a-a090-c603f9f1b4b2","name":"In Review","description":"Check for grammar and spellings, edit formatting and give feedback","read_only":true,"make_comment_mandatory":false},{"id":"ec0a4d2a-bb13-4c55-867e-1e9e0be07086","name":"Published","description":"Live,visible in KB","read_only":true,"make_comment_mandatory":false},{"id":"66e6cbc7-009b-4e11-883a-65ffec66b43a","name":"Unpublished","description":"","read_only":true,"make_comment_mandatory":false}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Get Workflow Statuses - 400 Bad Request response.": { "summary": "The below example shows an error response when the project ID is invalid or not found.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid project ID or project not found","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" } } } }, "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": [ ] } ] } }, "/v2/Project/Export": { "post": { "tags": [ "Project" ], "summary": "Starts a new export", "description": "**Request Body Parameters:**\r\n\r\n- `entity` (string) - Specifies the type of entity for which the export will be executed. For example, use \"Project\" to export content at the project level.\r\n\r\n- `version_id` (array of string) - List of unique version IDs where the export will be executed. Set to null to include all available workspaces or versions.\r\n\r\n- `selected_languages` (array of LanguageMeta) - List of languages to include in the export. Each object should define a specific language configuration.\r\n - `code` (string) - Language code (e.g., \"en\", \"fr\"). ISO language code for the selected language.\r\n - `id` (string) - Unique identifier of the language within the workspace.\r\n - `version_id` (string) - ID of the version associated with the selected language.\r\n\r\n- `selected_categories` (array of CategoryMeta) - List of categories to include in the export. Each item should follow the structure of a category and its metadata.\r\n - `language_id` (string) - ID of the language to which the category belongs. Set to null to include categories from all languages.\r\n - `id` (string) - Unique identifier of the category selected for export.\r\n\r\n- `exclude_media_files` (boolean) - Set to true to exclude all media files (images, attachments) from the export. Useful for generating lightweight exports.\r\n\r\n- `filter_by_article_modified_at` (object) - Used to apply a time-based filter on articles. Only articles modified within the date range will be included.\r\n - `after` (string/date-time) - Filters articles modified after this date (ISO 8601 format). Example: \"2025-06-13T14:30:00Z\"\r\n - `before` (string/date-time) - Filters articles modified before this date (ISO 8601 format). Example: \"2025-06-13T14:30:00Z\"\r\n\r\n- `export_type` (integer) - Specifies the format for the export.\r\n - `0` - JSON export (default) - generates .zip with structured JSON metadata and content files\r\n - `1` - HTML (offline documentation) - generates static HTML site packaged in .zip\r\n\r\n**Response (200 Success):**\r\n- `id` (string) - The unique ID of the export request. Use this ID to fetch or track export details in subsequent API calls.\r\n- `status` (string) - The current status of the export request. Helps determine the progress or result of the export operation.\r\n\r\n**Notes:**\r\n- For `Category` entity: Use `selectedCategories` to specify which categories to export (includes child categories and articles)\r\n- `selectedLanguages` filters which language versions to include in the export\r\n- Leave `selectedLanguages` and `selectedCategories` as empty arrays to export all available content", "operationId": "export", "requestBody": { "description": "Filter to export Full/Part of the documentation", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExportDocumentationRequest" } ] }, "examples": { "Export - Complete Project": { "summary": "To export the complete project, set Entity as 'Project'. All versions, languages, and categories will be automatically included. VersionId, SelectedLanguages, and SelectedCategories will be populated automatically.", "value": {"entity":"Project","version_id":[],"selected_languages":null,"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":null,"export_type":0} }, "Export - One or more project versions (all languages and categories)": { "summary": "To export one or more project versions with all languages and categories, set Entity as 'Version' and provide VersionId array. All languages and categories for the specified versions will be automatically included. Use /projectversions API to get version IDs.", "value": {"entity":"Version","version_id":["6558-7607-4594-ac82-e9b56aa8ab4","de558-7607-4594-ac82-e9b5bdfve34"],"selected_languages":null,"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":null,"export_type":0} }, "Export - Specific versions with selected languages": { "summary": "To export specific versions with selected languages, set Entity as 'Version' and provide both VersionId and SelectedLanguages. Categories for the specified versions and languages will be automatically included. If SelectedLanguages is not provided, all languages for the versions will be included.", "value": {"entity":"Version","version_id":["6558-7607-4594-ac82-e9b56aa8ab4","de558-7607-4594-ac82-e9b5bdfve34"],"selected_languages":[{"id":"de558-7607-4594-c2ds-e9b5bdfve34","code":"en","version_id":"6558-7607-4594-ac82-e9b56aa8ab4"},{"id":"8558-7607-4594-rt17-e9b56aa8ab4","code":"fr","version_id":"de558-7607-4594-ac82-e9b5bdfve34"}],"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":{"after":"2024-06-13T14:30:00","before":"2024-06-13T14:30:00"},"export_type":0} }, "Export - Specific categories": { "summary": "To export specific categories, set Entity as 'Category' and provide SelectedCategories with Id, LanguageId, and VersionId for each category. VersionId array and SelectedLanguages will be automatically derived from the provided categories.", "value": {"entity":"Category","version_id":null,"selected_languages":null,"selected_categories":[{"id":"Q58df-7607-4594-ac82-e9b5bdfe1h9","language_id":"lang-id-1","version_id":"6558-7607-4594-ac82-e9b56aa8ab4"},{"id":"Q58df-7607-4594-ac82-e9b5bdfe1h9","language_id":"lang-id-2","version_id":"de558-7607-4594-ac82-e9b5bdfve34"}],"exclude_media_files":true,"filter_by_article_modified_at":{"after":"2024-06-13T14:30:00","before":"2024-06-13T14:30:00"},"export_type":0} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExportDocumentationRequest" } ] }, "examples": { "Export - Complete Project": { "summary": "To export the complete project, set Entity as 'Project'. All versions, languages, and categories will be automatically included. VersionId, SelectedLanguages, and SelectedCategories will be populated automatically.", "value": {"entity":"Project","version_id":[],"selected_languages":null,"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":null,"export_type":0} }, "Export - One or more project versions (all languages and categories)": { "summary": "To export one or more project versions with all languages and categories, set Entity as 'Version' and provide VersionId array. All languages and categories for the specified versions will be automatically included. Use /projectversions API to get version IDs.", "value": {"entity":"Version","version_id":["6558-7607-4594-ac82-e9b56aa8ab4","de558-7607-4594-ac82-e9b5bdfve34"],"selected_languages":null,"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":null,"export_type":0} }, "Export - Specific versions with selected languages": { "summary": "To export specific versions with selected languages, set Entity as 'Version' and provide both VersionId and SelectedLanguages. Categories for the specified versions and languages will be automatically included. If SelectedLanguages is not provided, all languages for the versions will be included.", "value": {"entity":"Version","version_id":["6558-7607-4594-ac82-e9b56aa8ab4","de558-7607-4594-ac82-e9b5bdfve34"],"selected_languages":[{"id":"de558-7607-4594-c2ds-e9b5bdfve34","code":"en","version_id":"6558-7607-4594-ac82-e9b56aa8ab4"},{"id":"8558-7607-4594-rt17-e9b56aa8ab4","code":"fr","version_id":"de558-7607-4594-ac82-e9b5bdfve34"}],"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":{"after":"2024-06-13T14:30:00","before":"2024-06-13T14:30:00"},"export_type":0} }, "Export - Specific categories": { "summary": "To export specific categories, set Entity as 'Category' and provide SelectedCategories with Id, LanguageId, and VersionId for each category. VersionId array and SelectedLanguages will be automatically derived from the provided categories.", "value": {"entity":"Category","version_id":null,"selected_languages":null,"selected_categories":[{"id":"Q58df-7607-4594-ac82-e9b5bdfe1h9","language_id":"lang-id-1","version_id":"6558-7607-4594-ac82-e9b56aa8ab4"},{"id":"Q58df-7607-4594-ac82-e9b5bdfe1h9","language_id":"lang-id-2","version_id":"de558-7607-4594-ac82-e9b5bdfve34"}],"exclude_media_files":true,"filter_by_article_modified_at":{"after":"2024-06-13T14:30:00","before":"2024-06-13T14:30:00"},"export_type":0} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExportDocumentationRequest" } ] }, "examples": { "Export - Complete Project": { "summary": "To export the complete project, set Entity as 'Project'. All versions, languages, and categories will be automatically included. VersionId, SelectedLanguages, and SelectedCategories will be populated automatically.", "value": {"entity":"Project","version_id":[],"selected_languages":null,"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":null,"export_type":0} }, "Export - One or more project versions (all languages and categories)": { "summary": "To export one or more project versions with all languages and categories, set Entity as 'Version' and provide VersionId array. All languages and categories for the specified versions will be automatically included. Use /projectversions API to get version IDs.", "value": {"entity":"Version","version_id":["6558-7607-4594-ac82-e9b56aa8ab4","de558-7607-4594-ac82-e9b5bdfve34"],"selected_languages":null,"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":null,"export_type":0} }, "Export - Specific versions with selected languages": { "summary": "To export specific versions with selected languages, set Entity as 'Version' and provide both VersionId and SelectedLanguages. Categories for the specified versions and languages will be automatically included. If SelectedLanguages is not provided, all languages for the versions will be included.", "value": {"entity":"Version","version_id":["6558-7607-4594-ac82-e9b56aa8ab4","de558-7607-4594-ac82-e9b5bdfve34"],"selected_languages":[{"id":"de558-7607-4594-c2ds-e9b5bdfve34","code":"en","version_id":"6558-7607-4594-ac82-e9b56aa8ab4"},{"id":"8558-7607-4594-rt17-e9b56aa8ab4","code":"fr","version_id":"de558-7607-4594-ac82-e9b5bdfve34"}],"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":{"after":"2024-06-13T14:30:00","before":"2024-06-13T14:30:00"},"export_type":0} }, "Export - Specific categories": { "summary": "To export specific categories, set Entity as 'Category' and provide SelectedCategories with Id, LanguageId, and VersionId for each category. VersionId array and SelectedLanguages will be automatically derived from the provided categories.", "value": {"entity":"Category","version_id":null,"selected_languages":null,"selected_categories":[{"id":"Q58df-7607-4594-ac82-e9b5bdfe1h9","language_id":"lang-id-1","version_id":"6558-7607-4594-ac82-e9b56aa8ab4"},{"id":"Q58df-7607-4594-ac82-e9b5bdfe1h9","language_id":"lang-id-2","version_id":"de558-7607-4594-ac82-e9b5bdfve34"}],"exclude_media_files":true,"filter_by_article_modified_at":{"after":"2024-06-13T14:30:00","before":"2024-06-13T14:30:00"},"export_type":0} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ExportDocumentationRequest" } ] }, "examples": { "Export - Complete Project": { "summary": "To export the complete project, set Entity as 'Project'. All versions, languages, and categories will be automatically included. VersionId, SelectedLanguages, and SelectedCategories will be populated automatically.", "value": {"entity":"Project","version_id":[],"selected_languages":null,"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":null,"export_type":0} }, "Export - One or more project versions (all languages and categories)": { "summary": "To export one or more project versions with all languages and categories, set Entity as 'Version' and provide VersionId array. All languages and categories for the specified versions will be automatically included. Use /projectversions API to get version IDs.", "value": {"entity":"Version","version_id":["6558-7607-4594-ac82-e9b56aa8ab4","de558-7607-4594-ac82-e9b5bdfve34"],"selected_languages":null,"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":null,"export_type":0} }, "Export - Specific versions with selected languages": { "summary": "To export specific versions with selected languages, set Entity as 'Version' and provide both VersionId and SelectedLanguages. Categories for the specified versions and languages will be automatically included. If SelectedLanguages is not provided, all languages for the versions will be included.", "value": {"entity":"Version","version_id":["6558-7607-4594-ac82-e9b56aa8ab4","de558-7607-4594-ac82-e9b5bdfve34"],"selected_languages":[{"id":"de558-7607-4594-c2ds-e9b5bdfve34","code":"en","version_id":"6558-7607-4594-ac82-e9b56aa8ab4"},{"id":"8558-7607-4594-rt17-e9b56aa8ab4","code":"fr","version_id":"de558-7607-4594-ac82-e9b5bdfve34"}],"selected_categories":null,"exclude_media_files":true,"filter_by_article_modified_at":{"after":"2024-06-13T14:30:00","before":"2024-06-13T14:30:00"},"export_type":0} }, "Export - Specific categories": { "summary": "To export specific categories, set Entity as 'Category' and provide SelectedCategories with Id, LanguageId, and VersionId for each category. VersionId array and SelectedLanguages will be automatically derived from the provided categories.", "value": {"entity":"Category","version_id":null,"selected_languages":null,"selected_categories":[{"id":"Q58df-7607-4594-ac82-e9b5bdfe1h9","language_id":"lang-id-1","version_id":"6558-7607-4594-ac82-e9b56aa8ab4"},{"id":"Q58df-7607-4594-ac82-e9b5bdfe1h9","language_id":"lang-id-2","version_id":"de558-7607-4594-ac82-e9b5bdfve34"}],"exclude_media_files":true,"filter_by_article_modified_at":{"after":"2024-06-13T14:30:00","before":"2024-06-13T14:30:00"},"export_type":0} } } } }, "required": true }, "responses": { "200": { "description": "Export task created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportDocumentationResponse" }, "examples": { "Export Documentation - 200 Status response.": { "summary": "The below example shows the status response for export documentation. Here the export for a new documentation will be triggered.", "value": {"id":"69c2a0ee-bbac-4563-921c-08efef575b64","status":"Initiated","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "400": { "description": "Invalid request - check entity type, versionId, or other parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Export Documentation - 400 Status response invalid language code.": { "summary": "The below example shows the error status response says invalid language code.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The LanguageCode field is required","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Export Documentation - 400 Status response for reaching export documentation limit.": { "summary": "The below example shows the error status that you had reached the limit for the day.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Export API request limit(2) is reached for the day.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Export Documentation - 400 Status response for invalid entity field.": { "summary": "The below example shows the error status that the entity field should not be empty or invalid. Entity options are - 1.Project 2.Version , 3.Category , 4.Article ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Entity field 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" } } } }, "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": [ ] } ] } }, "/v2/Project/Import": { "post": { "tags": [ "Project" ], "summary": "Imports documentation", "description": "Sample request — import documentation from an external zip file URL:\r\n \r\n POST /Import\r\n {\r\n \"source_documentation_url\": \"https://yourdomain/documentation.zip\",\r\n \"publish_article\": true,\r\n \"import_by\": \"5a619a315481302d50b736d8\"\r\n }\r\n \r\nOnly Document360-format export archives are accepted. `import_by` is a team account ID (fetch via `GET /v2/teams`).", "operationId": "import", "requestBody": { "description": "Import payload — the source archive URL and import options.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ImportDocumentationRequest" } ] }, "examples": { " Import - Complete documention from external zip file url": { "summary": "To import the completedocumention from external zip file url. The Document360 only accept .zip files for SourceDocumentationURL.", "value": {"source_documentation_url":"https://yourdomain/documentation.zip","publish_article":true,"import_by":"5a619a315481302d50b736d8"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ImportDocumentationRequest" } ] }, "examples": { " Import - Complete documention from external zip file url": { "summary": "To import the completedocumention from external zip file url. The Document360 only accept .zip files for SourceDocumentationURL.", "value": {"source_documentation_url":"https://yourdomain/documentation.zip","publish_article":true,"import_by":"5a619a315481302d50b736d8"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ImportDocumentationRequest" } ] }, "examples": { " Import - Complete documention from external zip file url": { "summary": "To import the completedocumention from external zip file url. The Document360 only accept .zip files for SourceDocumentationURL.", "value": {"source_documentation_url":"https://yourdomain/documentation.zip","publish_article":true,"import_by":"5a619a315481302d50b736d8"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ImportDocumentationRequest" } ] }, "examples": { " Import - Complete documention from external zip file url": { "summary": "To import the completedocumention from external zip file url. The Document360 only accept .zip files for SourceDocumentationURL.", "value": {"source_documentation_url":"https://yourdomain/documentation.zip","publish_article":true,"import_by":"5a619a315481302d50b736d8"} } } } }, "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/ImportDocumentationResponse" }, "examples": { "Import Documentation - 200 Status response.": { "summary": "The below example shows the status response for import documentation. Here the import for a new documentation will be Queued.", "value": {"id":"e39bf9be-67be-4658-b28d-45d5794b25b0","status":"Queued","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Import Documentation - 400 Status response Invalid Url.": { "summary": "The below example shows the invalid DocumentationURL status respone. Kindly Verify your Zip file URL.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Source DocumentationURI, Document360 only accept .zip files.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Import Documentation - 400 Status response Not Authorized.": { "summary": "The below example shows that the import_by userId is invalid or Not Authorized to import this Document. Kindly Verify your import_by userId.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"You are not authorized to perform this activity.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Import Documentation - 400 Status response due to Null reference.": { "summary": "The below example shows that the import_by userId is empty, this field is required.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"ImportBy argument must not be null.","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" } } } }, "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": [ ] } ] } }, "/v2/ProjectVersions": { "get": { "tags": [ "ProjectVersions" ], "summary": "Gets the list of workspaces (project versions) in the project", "description": "This is the **primary discovery endpoint** — most other V1/V2 endpoints accept a `projectVersionId` that comes from here. Call this first when bootstrapping an integration.\r\nEach returned workspace has its own enabled languages, visibility flags (Beta / Deprecated / Public), and a `versionType` (`KnowledgeBase` or `ApiDocumentation`).\r\nSafe to retry; idempotent.", "operationId": "getProjectVersions", "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectVersionsResponse" }, "examples": { "Single workspace": { "summary": "A new project with one workspace ('v1') and one enabled language. Use each workspace's `id` as `projectVersionId` in other endpoints.", "value": {"data":[{"id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":1.0,"base_version_number":0.0,"version_code_name":"v1","is_main_version":true,"is_beta":false,"is_public":true,"is_deprecated":false,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","language_versions":[{"id":"lang-en-id","name":null,"code":"en","set_as_default":true,"hidden":false,"enable_rtl":false,"site_protection_level":0,"is_inheritance_disabled":false,"is_kb_inheritance_disabled":false,"has_inheritance_disabled_categories_or_articles":false,"has_kb_inheritance_disabled_categories_or_articles":false,"country_flag_code":null,"display_name":null,"is_home_page_enabled":false,"version_display_name":null}],"slug":"v1","order":0,"version_type":0}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Multi-workspace project with a deprecated and a beta workspace": { "summary": "A more mature project: a current GA workspace ('v2'), a Beta workspace ('v3-beta'), and an older deprecated workspace ('v1'). Each workspace has its own enabled languages and visibility flags.", "value": {"data":[{"id":"1a2b3c4d-5e6f-7890-abcd-ef1234567890","version_number":1.0,"base_version_number":0.0,"version_code_name":"v1","is_main_version":false,"is_beta":false,"is_public":true,"is_deprecated":true,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","language_versions":[{"id":"lang-en-id","name":null,"code":"en","set_as_default":true,"hidden":false,"enable_rtl":false,"site_protection_level":0,"is_inheritance_disabled":false,"is_kb_inheritance_disabled":false,"has_inheritance_disabled_categories_or_articles":false,"has_kb_inheritance_disabled_categories_or_articles":false,"country_flag_code":null,"display_name":null,"is_home_page_enabled":false,"version_display_name":null}],"slug":"v1","order":0,"version_type":0},{"id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","version_number":2.0,"base_version_number":1.0,"version_code_name":"v2","is_main_version":true,"is_beta":false,"is_public":true,"is_deprecated":false,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","language_versions":[{"id":"lang-en-id-v2","name":null,"code":"en","set_as_default":true,"hidden":false,"enable_rtl":false,"site_protection_level":0,"is_inheritance_disabled":false,"is_kb_inheritance_disabled":false,"has_inheritance_disabled_categories_or_articles":false,"has_kb_inheritance_disabled_categories_or_articles":false,"country_flag_code":null,"display_name":null,"is_home_page_enabled":false,"version_display_name":null},{"id":"lang-de-id-v2","name":null,"code":"de-DE","set_as_default":false,"hidden":false,"enable_rtl":false,"site_protection_level":0,"is_inheritance_disabled":false,"is_kb_inheritance_disabled":false,"has_inheritance_disabled_categories_or_articles":false,"has_kb_inheritance_disabled_categories_or_articles":false,"country_flag_code":null,"display_name":null,"is_home_page_enabled":false,"version_display_name":null}],"slug":"v2","order":0,"version_type":0},{"id":"c8d9e0f1-a2b3-4c4d-e5f6-a7b8c9d0e1f2","version_number":3.0,"base_version_number":2.0,"version_code_name":"v3-beta","is_main_version":false,"is_beta":true,"is_public":false,"is_deprecated":false,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","language_versions":[{"id":"lang-en-id-v3","name":null,"code":"en","set_as_default":true,"hidden":false,"enable_rtl":false,"site_protection_level":1,"is_inheritance_disabled":false,"is_kb_inheritance_disabled":false,"has_inheritance_disabled_categories_or_articles":false,"has_kb_inheritance_disabled_categories_or_articles":false,"country_flag_code":null,"display_name":null,"is_home_page_enabled":false,"version_display_name":null}],"slug":"v3-beta","order":0,"version_type":0}],"extension_data":null,"success":true,"errors":[],"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" } } } }, "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": [ ] } ] } }, "/v2/ProjectVersions/{projectVersionId}/{langCode}": { "get": { "tags": [ "ProjectVersions" ], "summary": "Searches for a phrase inside a workspace", "operationId": "searchProjectVersion", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`.", "required": true, "schema": { "type": "string" }, "example": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234" }, { "name": "searchQuery", "in": "query", "description": "Phrase to search across all articles in the workspace.", "schema": { "type": "string" }, "example": "how to publish an article" }, { "name": "langCode", "in": "path", "description": "Language code (for example `en`, `fr`, `de-DE`, `pt-BR`). Use `GET /v2/language/{projectVersionId}` to list the codes enabled for the workspace. Defaults to `en` when omitted.", "required": true, "schema": { "type": "string", "default": "en" }, "example": "en" }, { "name": "page", "in": "query", "description": "0-based page index. Valid range: 0–1000.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "example": 1 }, { "name": "hitsPerPage", "in": "query", "description": "Number of results per page. Valid range: 0–1000. Default: 10.", "schema": { "type": "integer", "format": "int32", "default": 10 }, "example": 10 } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchProjectVersionResponseCustomerApi" }, "examples": { "Example for 200 response": { "summary": "200 response in searches for a phrase inside project version", "value": {"data":{"hits":[{"title":"Understanding Home page builder","content":"The home page is the first page an end-user will see when they visit your knowledge base. The Home Page Builder lets you customize your home page by adding links, changing colors, including categories from your knowledge base, and more. \n The home page builder comes with an intuitive interface to design a professional looking front-page to your knowledge base. You do not need any developer support to create a good looking home page. \n If you do not want a home page and would like to direct the user directly to the real content, you can easily turn off the home page for your knowledge base. \n \n \n This is a sample article, you can safely delete it. \n \n","is_hidden":false,"tags":[],"slug":"understanding-home-page-builder","version":1,"article_id":"6116080f-5b38-4037-b878-82d318543dsw","category_id":"6116080f-5b38-4037-b878-82d318543af","is_category_hidden":null,"order":5,"is_draft":false,"is_unpublished":null,"exclude":false,"breadcrumb":null,"is_category":null,"attachment_ids":null,"is_deleted":null,"is_folder_type_category":null,"updated_on_timestamp":null,"is_private":null,"language_id":null,"project_id":null,"is_latest_version":null,"contributors":null,"is_shared_article":null,"lang_code":null,"category_unique_id":null,"unique_id":null,"deleted_by":null,"deleted_at":null,"is_git_hub_entity":null,"original_article_id":null,"object_id":"","_snippet_result":{"content":{"value":" The home page is the first page an end-user will see when they visit your knowledge base. The Home Page Builder lets you customize your home page by adding links, changing colors, including categories from your knowledge base, and more. \n The home page builder comes with an intuitive","match_level":""}},"_highlight_result":{"title":null}}],"nb_hits":null,"page":null,"nb_pages":null,"hits_per_page":null,"processing_time_ms":null,"query":null},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Example for 400 response due to project version Id ": { "summary": "400 bad response due to invalid Project version Id ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id does not exist in your project","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "Example for 400 response due to Lanuage Code ": { "summary": "400 bad response due to invalid Language Code ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Invalid Language code","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": [ ] } ] } }, "/v2/ProjectVersions/{projectVersionId}/apireferences": { "get": { "tags": [ "ProjectVersions" ], "summary": "Gets the list of API references within a workspace", "operationId": "getApiDefinitionId", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`.", "required": true, "schema": { "type": "string" }, "example": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetApiReferenceDataResponseCustomer" }, "examples": { "Success status Response": { "summary": "This is the sample response for this endpoint.", "value": {"data":[{"id":"d8a7dfb6-0539-4583-9af2-1bd40863f866","name":"1412706f-d63e-4070-9af7-3af2b77616bb","upload_type":"23c9f6c4-0b90-49e4-abb4-0ac11da3af50"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Invalid project version ID": { "summary": "Kindly ensure the project version ID is valid and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[],"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": [ ] } ] } }, "/v2/ProjectVersions/{projectVersionId}/articles": { "get": { "tags": [ "ProjectVersions" ], "summary": "Gets the list of articles within a workspace", "description": "Flat list of all articles in the workspace — useful when you don't need the category hierarchy and just want every `articleId`. For the tree-shaped view, use `GET /v2/projectversions/{projectVersionId}/categories`.\r\nSet `hitsPerPage` to a positive value to enable pagination; leave at 0 to return all articles (capped at 1000).\r\nSafe to retry; idempotent.", "operationId": "getArticles", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`.", "required": true, "schema": { "type": "string" }, "example": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234" }, { "name": "langCode", "in": "query", "description": "Language code (for example `en`, `fr`, `de-DE`, `pt-BR`). Use `GET /v2/language/{projectVersionId}` to list the codes enabled for the workspace. When omitted, the workspace's default language is used.", "schema": { "type": "string" }, "example": "en" }, { "name": "page", "in": "query", "description": "0-based page index. Used for pagination when `hitsPerPage > 0`. Default: 0.", "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "hitsPerPage", "in": "query", "description": "Number of results per page. Default: 0 = return all articles. Maximum: 100.", "schema": { "type": "integer", "format": "int32" }, "example": 10 }, { "name": "securityVisibility", "in": "query", "description": "Optional protection level filter: `0` Public, `1` Protected. When omitted, returns all articles regardless of protection level.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetArticlesResponseCustomer" }, "examples": { "Articles in workspace": { "summary": "List of articles inside the workspace. Each article's `id` is usable as `articleId` in other endpoints.", "value": {"data":[{"url":"https://example.com/v1/docs/en/why-did-we-build-document360","exclude_from_external_search":false,"security_visibility":null,"id":"7db99386-2816-40f0-991f-174dgdscf","title":"Why did we build Document360?","public_version":1,"latest_version":1,"language_code":null,"hidden":false,"status":0,"order":1,"slug":"why-did-we-build-document360","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":null,"current_workflow_status_id":"ffe60c61-6418-4437-afd3-01a9a2054bab"}],"pagination":null,"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Example for 400 response due to invalid Project version Id": { "summary": "400 bad response due to invalid Project version Id ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The supplied project version id does not exist in your project","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": [ ] } ] } }, "/v2/ProjectVersions/{projectVersionId}/categories": { "get": { "tags": [ "ProjectVersions" ], "summary": "Gets the category hierarchy within a workspace", "description": "Returns the full category tree (categories + their articles + child categories, recursively). This is the second discovery endpoint after `GET /v2/projectversions` — most integrations call this once to map out the workspace's `categoryId` and `articleId` values.\r\nSet `excludeArticles=true` for a lighter payload when you only need the category skeleton.\r\nSet `securityVisibility=1` to restrict the result to private categories only.\r\nSafe to retry; idempotent.", "operationId": "getCategories", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`.", "required": true, "schema": { "type": "string" }, "example": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234" }, { "name": "excludeArticles", "in": "query", "description": "When `true`, the response omits articles inside categories (lighter payload). When `false`, articles are included.", "schema": { "type": "boolean" }, "example": false }, { "name": "langCode", "in": "query", "description": "Language code (for example `en`, `fr`, `de-DE`, `pt-BR`). Use `GET /v2/language/{projectVersionId}` to list the codes enabled for the workspace. When omitted, the workspace's default language is used.", "schema": { "type": "string" }, "example": "en" }, { "name": "includeCategoryDescription", "in": "query", "description": "When `true`, includes the category description in the response.", "schema": { "type": "boolean", "default": false }, "example": false }, { "name": "securityVisibility", "in": "query", "description": "Optional protection level filter: `0` Public, `1` Private. When omitted, returns all categories regardless of protection level.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCategoriesResponse" }, "examples": { "Example for 200 response": { "summary": "200 response in get list of categories within project version", "value": {"data":[{"articles":[{"url":null,"exclude_from_external_search":false,"security_visibility":null,"id":"c31b0a18-5416-4cef-b165-83d9b52ada43","title":"Why did we build Document360?","public_version":1,"latest_version":1,"language_code":null,"hidden":false,"status":0,"order":1,"slug":"why-did-we-build-document360","content_type":null,"translation_option":0,"is_shared_article":false,"created_at":null,"modified_at":null,"current_workflow_status_id":"9fc4dd1a-ee83-489f-994d-ddf43c9b4b18"}],"child_categories":[],"exclude_from_external_search":false,"security_visibility":0,"id":"f587e278-4205-4a07-a6b7-28dc9caf6f48","name":"Getting started","description":"This is the description of the getting started category.","project_version_id":"ad76e483-6ef7-4e43-b53f-4fe5e52sefw","order":1,"parent_category_id":null,"hidden":false,"icon":null,"slug":"getting-started","language_code":null,"category_type":0,"created_at":"2024-06-13T14:30:00","modified_at":"2024-06-13T14:30:00","status":null,"content_type":null,"current_workflow_status_id":"7fc4dd1a-ee83-489f-994d-ddf43c9b4b18"}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Example for 400 response": { "summary": "400 response in get list of categories within project version", "value": {"extension_data":null,"success":true,"errors":[],"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": [ ] } ] } }, "/v2/ProjectVersions/ask-ai-feedback": { "post": { "tags": [ "ProjectVersions" ], "summary": "Provides feedback for an AI assistive search response", "operationId": "postPublicAISearchAnswerFeedback", "requestBody": { "description": "Feedback payload. `entityId` ties the feedback to a previous AI search response; `isLiked` is a thumbs-up/down signal.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublicAPIAIFeedbackRequest" } ] }, "examples": { "Resync API reference request": { "summary": "Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.", "value": {"entity_id":"","is_liked":false,"comments":"","notify_me_about_changes":false,"feedback_provider_email":"","additional_feedback_info":{"need_more_information":false,"difficult_to_understand":false,"irrelevant_content":false,"incorrect_source_reference":false,"missing_information":false,"dont_like_style":false,"others":false,"comments":false},"feedback_sub_type":0} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublicAPIAIFeedbackRequest" } ] }, "examples": { "Resync API reference request": { "summary": "Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.", "value": {"entity_id":"","is_liked":false,"comments":"","notify_me_about_changes":false,"feedback_provider_email":"","additional_feedback_info":{"need_more_information":false,"difficult_to_understand":false,"irrelevant_content":false,"incorrect_source_reference":false,"missing_information":false,"dont_like_style":false,"others":false,"comments":false},"feedback_sub_type":0} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublicAPIAIFeedbackRequest" } ] }, "examples": { "Resync API reference request": { "summary": "Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.", "value": {"entity_id":"","is_liked":false,"comments":"","notify_me_about_changes":false,"feedback_provider_email":"","additional_feedback_info":{"need_more_information":false,"difficult_to_understand":false,"irrelevant_content":false,"incorrect_source_reference":false,"missing_information":false,"dont_like_style":false,"others":false,"comments":false},"feedback_sub_type":0} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PublicAPIAIFeedbackRequest" } ] }, "examples": { "Resync API reference request": { "summary": "Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.", "value": {"entity_id":"","is_liked":false,"comments":"","notify_me_about_changes":false,"feedback_provider_email":"","additional_feedback_info":{"need_more_information":false,"difficult_to_understand":false,"irrelevant_content":false,"incorrect_source_reference":false,"missing_information":false,"dont_like_style":false,"others":false,"comments":false},"feedback_sub_type":0} } } } }, "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/BaseResponse" }, "examples": { "Success status response": { "summary": "This is sample response for this endpoint.", "value": {"extension_data":null,"context":null,"success":true,"errors":[],"warnings":[],"information":[],"feature_explorer_status":null,"custom_page_element":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/BaseResponse" }, "examples": { "Invalid analyticsId": { "summary": "Kindly ensure the analyticsId is not empty and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"AnalyticsId should not be empty","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid projectDocumentVersionId": { "summary": "Kindly ensure the projectDocumentVersionId is not empty and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"ProjectDocumentVersionId should not be empty","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid languageCode": { "summary": "Kindly ensure the languageCode is not empty and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"LanguageCode should not be empty","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/ProjectVersions/ask-eddy": { "post": { "tags": [ "ProjectVersions" ], "summary": "Performs an AI assistive search within a workspace", "operationId": "getPublicAISearchAnswer", "requestBody": { "description": "AI search payload. `prompt`, `versionId` (workspace ID — fetch via `GET /v2/projectversions`), and `languageCode` are required.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AIAssistiveSearchRequest" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AIAssistiveSearchRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AIAssistiveSearchRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AIAssistiveSearchRequest" } ] } } }, "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/AIAssistiveSearch" }, "examples": { "Success status response": { "summary": "This is sample response for this endpoint.", "value": {"prompt":"How to configure single sign-on in Document360?","result":"

To configure Single Sign On in Document360, follow these steps:



  1. Access the Azure AD portal and log in to your Microsoft Azure account.

  2. Add your application by logging in to your Azure account, visiting the Azure portal page, and selecting the New application option.

  3. Navigate to Document360 portal, select Settings → Users Security → SAML/OpenID → SAML, and set up your application by copying the parameters from Document360 to the Azure AD portal.

  4. Configure SAML based SSO settings by copying and pasting values between Document360 and Azure AD portal.

  5. Test the configuration by logging into Document360 using the credentials added to the registered application.

\",\r\n","reference_articles":[{"id":null,"citation_id":null,"category_id":"807cafd4-5d9b-4be6-becd-906f1509b0db","category_title":"SAML","category_slug":"saml","version_name":"Document360 2.0","version_slug":"help","article_id":"fb0444b1-6ff6-41dc-b68b-93e86c0470cc","article_title":"SAML SSO with Azure AD","article_slug":"saml-sso-with-azure-ad","version_display_name":null,"language_code":null,"data_source_type":0,"external_source_link":null,"external_source_name":null,"external_source_id":null,"external_source_record_id":null,"external_source_type":null,"is_attachment":false,"attachment_url":null,"attachment_title":null},{"id":null,"citation_id":null,"category_id":"807cafd4-5d9b-4be6-becd-906f1509b0db","category_title":"SAML","category_slug":"saml","version_name":"Document360 2.0","version_slug":"help","article_id":"4a88b443-fbdb-4dc7-882a-e802bb9de6e9","article_title":"Identity Provider (IdP) initiated login","article_slug":"idp-initiated-login","version_display_name":null,"language_code":null,"data_source_type":0,"external_source_link":null,"external_source_name":null,"external_source_id":null,"external_source_record_id":null,"external_source_type":null,"is_attachment":false,"attachment_url":null,"attachment_title":null},{"id":null,"citation_id":null,"category_id":null,"category_title":null,"category_slug":null,"version_name":null,"version_slug":null,"article_id":null,"article_title":null,"article_slug":null,"version_display_name":null,"language_code":null,"data_source_type":1,"external_source_link":"https://example.com/","external_source_name":"Example source","external_source_id":null,"external_source_record_id":null,"external_source_type":null,"is_attachment":false,"attachment_url":null,"attachment_title":null}],"limit_exceeded":false,"analytics_id":"8ac6020b-d329-4968-b562-5497c88e65a6","remaining_credits":10,"extension_data":null,"context":null,"success":true,"errors":[],"warnings":[],"information":[],"feature_explorer_status":null,"custom_page_element":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": { "Invalid prompt": { "summary": "Kindly ensure the prompt is not empty and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Prompt should not be empty","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid project version ID": { "summary": "Kindly ensure the project version ID is not empty and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Project version ID should not be empty","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invalid language code": { "summary": "Kindly ensure the language code is not empty and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Language Code should not be empty","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Public API access is disabled": { "summary": "Kindly ensure the public API is enabled and perform the task again. ", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"API access is disabled. Please contact your project administrator.","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/Readers": { "get": { "tags": [ "Readers" ], "summary": "Gets all available readers from the project", "description": "Returns readers in the project's \"Readers\" pool. Pagination is page-based: each page returns up to 5000 readers. Sort order is server-defined and stable across pages.\r\n`searchEmail` is a server-side substring filter on the email address (case-insensitive). Combine with `offSet=1` for the first matching page.\r\nSafe to retry; idempotent.", "operationId": "getAllReaders", "parameters": [ { "name": "offSet", "in": "query", "description": "1-based page number. Each page returns up to 5000 readers. Default: 1.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "searchEmail", "in": "query", "description": "Filters the result to readers whose email contains this substring. Omit to return all readers on the page.", "schema": { "type": "string" }, "example": "peter.jone@example.com" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetReaderResponseCustomer" }, "examples": { "Reader with project-level access": { "summary": "A standard reader who can see the entire project (every workspace, every category).", "value": {"reader_id":"91b70808-3d15-45e0-a641-f03e2a0b0efd","first_name":"Peter","last_name":"Jone","email":"peterjone@mail.com","access_scope":{"access_level":3,"categories":[],"project_versions":[],"languages":[]},"associated_reader_groups":[],"is_invite_sso_user":false,"last_login_at":"2026-04-12T09:15:00Z"} }, "Reader with category-scoped access": { "summary": "A reader whose visibility is restricted to a single category in one workspace. Membership in a reader group inherits the group's scope.", "value": {"reader_id":"a7f2c5e1-8d4b-4cba-9f10-2b3c4d5e6f70","first_name":"Anita","last_name":"Rao","email":"anita.rao@example.com","access_scope":{"access_level":1,"categories":[{"category_id":"c1d2e3f4-a5b6-4c7d-e8f9-a0b1c2d3e4f5","project_version_id":"46f48bc7-760f-4b07-b2d2-fce4aa8ba234","language_code":"en"}],"project_versions":[],"languages":[]},"associated_reader_groups":["b2c3d4e5-f6a7-4b8c-9d0e-a1b2c3d4e5f6"],"is_invite_sso_user":false,"last_login_at":"2026-05-03T14:42:00Z"} }, "SSO-invited reader (never signed in)": { "summary": "A reader invited via SSO who has not yet completed their first sign-in. `lastLoginAt` is null and `isInviteSsoUser` is true.", "value": {"reader_id":"e5f6a7b8-c9d0-4e1f-a2b3-c4d5e6f7a8b9","first_name":"Bob","last_name":"Martinez","email":"bob.martinez@example.com","access_scope":{"access_level":2,"categories":[],"project_versions":["46f48bc7-760f-4b07-b2d2-fce4aa8ba234"],"languages":[]},"associated_reader_groups":[],"is_invite_sso_user":true,"last_login_at":null} } } } } }, "401": { "description": "Authentication failed — the `api_token` header is missing, malformed, or has been revoked.", "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": [ ] } ] }, "post": { "tags": [ "Readers" ], "summary": "Adds a new reader", "description": "Creates a reader account in the project. The reader receives an invitation email unless `skipSsoInvitationEmail` is `true` for an SSO user.\r\nGroup memberships passed in `associatedReaderGroups` inherit the group's access scope.\r\n**Not idempotent** — list readers first (`GET /v2/readers?searchEmail=…`) before retrying after a 5xx to avoid creating duplicate accounts.", "operationId": "addReader", "requestBody": { "description": "Reader creation payload. `emailId` is required; optional fields include `firstName`, `lastName`, and group assignments.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddReaderRequestV2" } ] }, "examples": { "ReadersGroup - Add a new reader with access level None.": { "summary": "Here you can add new reader with access scope and access level as None.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Article.": { "summary": "Here you can add new reader with access scope and access level to Article.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Category.": { "summary": "Here you can add new reader with access scope and access level to Category.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":1,"categories":[{"project_version_id":"d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3","category_id":"s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2","language_code":"en"}],"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Language.": { "summary": "Here you can add new reader with access scope and access level to Language.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"4rb5c7e-fcbe-4797-b144-1a7ca2508fdr","language_code":"en"}]},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Project.": { "summary": "Here you can add new reader with access scope and access level to Project.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Version.": { "summary": "Here you can add new reader with access scope and access level to Version.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddReaderRequestV2" } ] }, "examples": { "ReadersGroup - Add a new reader with access level None.": { "summary": "Here you can add new reader with access scope and access level as None.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Article.": { "summary": "Here you can add new reader with access scope and access level to Article.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Category.": { "summary": "Here you can add new reader with access scope and access level to Category.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":1,"categories":[{"project_version_id":"d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3","category_id":"s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2","language_code":"en"}],"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Language.": { "summary": "Here you can add new reader with access scope and access level to Language.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"4rb5c7e-fcbe-4797-b144-1a7ca2508fdr","language_code":"en"}]},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Project.": { "summary": "Here you can add new reader with access scope and access level to Project.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Version.": { "summary": "Here you can add new reader with access scope and access level to Version.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddReaderRequestV2" } ] }, "examples": { "ReadersGroup - Add a new reader with access level None.": { "summary": "Here you can add new reader with access scope and access level as None.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Article.": { "summary": "Here you can add new reader with access scope and access level to Article.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Category.": { "summary": "Here you can add new reader with access scope and access level to Category.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":1,"categories":[{"project_version_id":"d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3","category_id":"s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2","language_code":"en"}],"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Language.": { "summary": "Here you can add new reader with access scope and access level to Language.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"4rb5c7e-fcbe-4797-b144-1a7ca2508fdr","language_code":"en"}]},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Project.": { "summary": "Here you can add new reader with access scope and access level to Project.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Version.": { "summary": "Here you can add new reader with access scope and access level to Version.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddReaderRequestV2" } ] }, "examples": { "ReadersGroup - Add a new reader with access level None.": { "summary": "Here you can add new reader with access scope and access level as None.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Article.": { "summary": "Here you can add new reader with access scope and access level to Article.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Category.": { "summary": "Here you can add new reader with access scope and access level to Category.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":1,"categories":[{"project_version_id":"d4fb5c7e-fcbe-4797-b144-1a7ca2508fe3","category_id":"s5fb5c7e-fcbe-4797-b144-1a7ca2508fq2","language_code":"en"}],"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Language.": { "summary": "Here you can add new reader with access scope and access level to Language.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"4rb5c7e-fcbe-4797-b144-1a7ca2508fdr","language_code":"en"}]},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Project.": { "summary": "Here you can add new reader with access scope and access level to Project.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} }, "ReadersGroup - Add a new reader with access level to Version.": { "summary": "Here you can add new reader with access scope and access level to Version.", "value": {"first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","associated_reader_groups":null,"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"invited_by":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50"} } } } }, "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/StringCustomerApiResponse" }, "examples": { "Readers - Success Response for adding new readers.": { "summary": "This is an example for 200 status, success response.", "value": {"result":"1c8e9f29-33e8-4301-af1d-dbf3c15a2782","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 - InvitedBy filed is missing": { "summary": "Kindly add InvitedBy field as it is required.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The InvitedBy field is required.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Readers - Email field is missing": { "summary": "Kindly add Email field as it is required.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Email Address is required.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Readers - AccessScope field is missing": { "summary": "Kindly add access_scope field as it is required.", "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":[],"information":[]} } } } } }, "401": { "description": "Authentication failed — the `api_token` header is missing, malformed, or has been revoked.", "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": [ ] } ] } }, "/v2/Readers/groups": { "get": { "tags": [ "Readers" ], "summary": "Gets all reader groups", "operationId": "getAllReaderGroups", "parameters": [ { "name": "offSet", "in": "query", "description": "1-based page number. Each page returns up to 5 reader groups. Default: 1.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "excludeReaders", "in": "query", "description": "When `true`, the group response omits its readers (lighter payload). When `false`, readers are included.", "schema": { "type": "boolean", "default": false }, "example": false } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReaderGroupCustomerV2ListCustomerApiResponse" }, "examples": { "Multiple reader groups": { "summary": "A typical page response — two groups with different access scopes: one project-wide, one scoped to a workspace, and (in real responses) one excluded for brevity.", "value": {"result":[{"reader_group_id":"047ec4da-d8d3-4bfe-ae83-fff9f4e1f6ae","title":"Enterprise Customers","description":"Readers from enterprise-tier customer accounts.","associated_readers":["91b70808-3d15-45e0-a641-f03e2a0b0efd","a7f2c5e1-8d4b-4cba-9f10-2b3c4d5e6f70"],"associated_invited_sso_users":[],"access_scope":{"access_level":3,"categories":[],"project_versions":[],"languages":[]}},{"reader_group_id":"b2c3d4e5-f6a7-4b8c-9d0e-a1b2c3d4e5f6","title":"Beta Testers","description":"Readers participating in the beta documentation program.","associated_readers":["e5f6a7b8-c9d0-4e1f-a2b3-c4d5e6f7a8b9"],"associated_invited_sso_users":[],"access_scope":{"access_level":2,"categories":[],"project_versions":["46f48bc7-760f-4b07-b2d2-fce4aa8ba234"],"languages":[]}}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "No reader groups configured": { "summary": "Empty result — the project has no reader groups yet. `result` is an empty array.", "value": {"result":[],"extension_data":null,"success":true,"errors":[],"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" } } } }, "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": [ ] } ] }, "post": { "tags": [ "Readers" ], "summary": "Adds a new reader group", "operationId": "addReaderGroup", "requestBody": { "description": "Reader group creation payload. `name` is required; optional fields include the group's content access scope.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddReaderGroupRequestV2" } ] }, "examples": { "ReadersGroup - Add a new readers groups with access level None.": { "summary": "Here you can add new readers group with access scope and access level as None.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Article.": { "summary": "Here you can add new readers group with access scope and access level to Article.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Category.": { "summary": "Here you can add new readers group with access scope and access level to Category.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":1,"categories":[{"project_version_id":"rffb5c7e-fcbe-4797-b144-1a7ca2508fvew","category_id":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50","language_code":"en"}],"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Language.": { "summary": "Here you can add new readers group with access scope and access level to particular Language.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"adfb5c7e-fcbe-4797-b144-1a7ca2508fdd","language_code":"en"}]},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Project.": { "summary": "Here you can add new readers group with access scope and access level to Project.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":3,"categories":null,"project_versions":["adfb5c7e-fcbe-4797-b144-1a7ca2508fdd","adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"],"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Version.": { "summary": "Here you can add new readers group with access scope and access level to Version.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddReaderGroupRequestV2" } ] }, "examples": { "ReadersGroup - Add a new readers groups with access level None.": { "summary": "Here you can add new readers group with access scope and access level as None.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Article.": { "summary": "Here you can add new readers group with access scope and access level to Article.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Category.": { "summary": "Here you can add new readers group with access scope and access level to Category.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":1,"categories":[{"project_version_id":"rffb5c7e-fcbe-4797-b144-1a7ca2508fvew","category_id":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50","language_code":"en"}],"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Language.": { "summary": "Here you can add new readers group with access scope and access level to particular Language.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"adfb5c7e-fcbe-4797-b144-1a7ca2508fdd","language_code":"en"}]},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Project.": { "summary": "Here you can add new readers group with access scope and access level to Project.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":3,"categories":null,"project_versions":["adfb5c7e-fcbe-4797-b144-1a7ca2508fdd","adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"],"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Version.": { "summary": "Here you can add new readers group with access scope and access level to Version.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddReaderGroupRequestV2" } ] }, "examples": { "ReadersGroup - Add a new readers groups with access level None.": { "summary": "Here you can add new readers group with access scope and access level as None.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Article.": { "summary": "Here you can add new readers group with access scope and access level to Article.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Category.": { "summary": "Here you can add new readers group with access scope and access level to Category.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":1,"categories":[{"project_version_id":"rffb5c7e-fcbe-4797-b144-1a7ca2508fvew","category_id":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50","language_code":"en"}],"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Language.": { "summary": "Here you can add new readers group with access scope and access level to particular Language.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"adfb5c7e-fcbe-4797-b144-1a7ca2508fdd","language_code":"en"}]},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Project.": { "summary": "Here you can add new readers group with access scope and access level to Project.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":3,"categories":null,"project_versions":["adfb5c7e-fcbe-4797-b144-1a7ca2508fdd","adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"],"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Version.": { "summary": "Here you can add new readers group with access scope and access level to Version.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddReaderGroupRequestV2" } ] }, "examples": { "ReadersGroup - Add a new readers groups with access level None.": { "summary": "Here you can add new readers group with access scope and access level as None.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Article.": { "summary": "Here you can add new readers group with access scope and access level to Article.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Category.": { "summary": "Here you can add new readers group with access scope and access level to Category.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":1,"categories":[{"project_version_id":"rffb5c7e-fcbe-4797-b144-1a7ca2508fvew","category_id":"8dfb5c7e-fcbe-4797-b144-1a7ca2508f50","language_code":"en"}],"project_versions":null,"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Language.": { "summary": "Here you can add new readers group with access scope and access level to particular Language.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"adfb5c7e-fcbe-4797-b144-1a7ca2508fdd","language_code":"en"}]},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Project.": { "summary": "Here you can add new readers group with access scope and access level to Project.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"access_scope":{"access_level":3,"categories":null,"project_versions":["adfb5c7e-fcbe-4797-b144-1a7ca2508fdd","adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"],"languages":null},"associated_invited_sso_users":null} }, "ReadersGroup - Add a new readers groups with access level to Version.": { "summary": "Here you can add new readers group with access scope and access level to Version.", "value": {"title":"ReadersGroupName","description":"For better undestanding make a breif note of readers group description.","associated_readers":[],"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/StringCustomerApiResponse" }, "examples": { "Readers - Success Response for add reader group": { "summary": "This is an example for 200 status, success response.", "value": {"result":"02050a57-47e3-41b0-9f88-832c643abb8c","extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 - Missing of Access Scope": { "summary": "Kindly add access_scope field as it is mandatory.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The AccessScope field is required.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Readers - Missing of Title": { "summary": "Kindly add title field as it is mandatory.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The Title field is required.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Readers - Title already exist": { "summary": "Kindly change title name as it is already exist.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"Title Name already exists. Title has to be unique.","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/Readers/groups/{groupId}": { "get": { "tags": [ "Readers" ], "summary": "Gets a reader group via group id", "operationId": "getReaderGroupById", "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" }, { "name": "offSet", "in": "query", "description": "1-based page number. Each page returns up to 5000 readers in the group. Default: 1.", "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReaderGroupCustomerV2CustomerApiResponse" }, "examples": { "Readers - Success Response for update reader": { "summary": "This is an example for 200 status, success response.", "value": {"result":{"reader_group_id":"1c8e9f29-33e8-4301-af1d-dbf3c15a2782","title":"ReadersGroupTitle","description":"This is the Readers Group Description.","associated_readers":[],"associated_invited_sso_users":[],"access_scope":{"access_level":3,"categories":[],"project_versions":[],"languages":[]}},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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 - Invalid reader ID": { "summary": "Kindly verify your readers group Id and perform the operation again. This seems to be an error while finding the reader group Id, to find your readers 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} } } } } }, "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": [ ] } ] }, "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "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": [ ] } ] }, "delete": { "tags": [ "Readers" ], "summary": "Deletes a reader group", "operationId": "deleteReaderGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "The ID of the reader group to delete. Fetch via `GET /v2/readers/groups`.", "required": true, "schema": { "type": "string" }, "example": "047ec4da-d8d3-4bfe-ae83-fff9f4e1f6ae" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Readers - Success Response for update reader": { "summary": "This is an example for 200 status, success response.", "value": {"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 - Success Response for update reader": { "summary": "Kindly verify your readers group Id. You can find your reader group Id from /v2/Readers/groups/{groupId}.", "value": {"extension_data":null,"success":true,"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} } } } } }, "401": { "description": "Authentication failed — the `api_token` header is missing, malformed, or has been revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" } } } }, "403": { "description": "The caller's plan, license, or role does not include this feature or permission.", "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": [ ] } ] } }, "/v2/Readers/{readerId}": { "put": { "tags": [ "Readers" ], "summary": "Updates a reader", "operationId": "updateReader", "parameters": [ { "name": "readerId", "in": "path", "description": "The ID of the reader. Fetch via `GET /v2/readers`. When `isInvitationId` is `true`, this is the invitation ID instead.", "required": true, "schema": { "type": "string" }, "example": "91b70808-3d15-45e0-a641-f03e2a0b0efd" } ], "requestBody": { "description": "Partial reader update payload. Only the fields present in the request body are updated.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateReaderRequestV2" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "ReadersGroup - -Update an existing reader with access level None.": { "summary": "Here you can edit the reader with the access permission as None. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Article.": { "summary": "Here you can edit the reader with the access permission as Article. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Category.": { "summary": "Here you can edit the reader with the access permission as Category. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":1,"categories":[{"project_version_id":"rfb5c7e-fcbe-4797-b144-1a7ca2508f3","category_id":"fb57e-fcbe-47xz7-b1d4-1a7ca2508f3e","language_code":"en"}],"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Language.": { "summary": "Here you can edit the reader with the access permission as Language. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"e3f5c7e-fcbe-4797-b144-1a7ca2508f5d","language_code":"en"}]},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Project.": { "summary": "Here you can edit the reader with the access permission as Project. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Version.": { "summary": "Here you can edit the reader with the access permission as Version. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateReaderRequestV2" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "ReadersGroup - -Update an existing reader with access level None.": { "summary": "Here you can edit the reader with the access permission as None. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Article.": { "summary": "Here you can edit the reader with the access permission as Article. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Category.": { "summary": "Here you can edit the reader with the access permission as Category. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":1,"categories":[{"project_version_id":"rfb5c7e-fcbe-4797-b144-1a7ca2508f3","category_id":"fb57e-fcbe-47xz7-b1d4-1a7ca2508f3e","language_code":"en"}],"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Language.": { "summary": "Here you can edit the reader with the access permission as Language. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"e3f5c7e-fcbe-4797-b144-1a7ca2508f5d","language_code":"en"}]},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Project.": { "summary": "Here you can edit the reader with the access permission as Project. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Version.": { "summary": "Here you can edit the reader with the access permission as Version. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateReaderRequestV2" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "ReadersGroup - -Update an existing reader with access level None.": { "summary": "Here you can edit the reader with the access permission as None. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Article.": { "summary": "Here you can edit the reader with the access permission as Article. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Category.": { "summary": "Here you can edit the reader with the access permission as Category. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":1,"categories":[{"project_version_id":"rfb5c7e-fcbe-4797-b144-1a7ca2508f3","category_id":"fb57e-fcbe-47xz7-b1d4-1a7ca2508f3e","language_code":"en"}],"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Language.": { "summary": "Here you can edit the reader with the access permission as Language. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"e3f5c7e-fcbe-4797-b144-1a7ca2508f5d","language_code":"en"}]},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Project.": { "summary": "Here you can edit the reader with the access permission as Project. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Version.": { "summary": "Here you can edit the reader with the access permission as Version. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateReaderRequestV2" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "ReadersGroup - -Update an existing reader with access level None.": { "summary": "Here you can edit the reader with the access permission as None. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Article.": { "summary": "Here you can edit the reader with the access permission as Article. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":5,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Category.": { "summary": "Here you can edit the reader with the access permission as Category. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":1,"categories":[{"project_version_id":"rfb5c7e-fcbe-4797-b144-1a7ca2508f3","category_id":"fb57e-fcbe-47xz7-b1d4-1a7ca2508f3e","language_code":"en"}],"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Language.": { "summary": "Here you can edit the reader with the access permission as Language. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"e3f5c7e-fcbe-4797-b144-1a7ca2508f5d","language_code":"en"}]},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Project.": { "summary": "Here you can edit the reader with the access permission as Project. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} }, "ReadersGroup - -Update an existing reader with access level as Version.": { "summary": "Here you can edit the reader with the access permission as Version. Also add readerId in the path to complete the request.", "value": {"first_name":"Peter","last_name":"Jone","associated_reader_groups":["se3f5c7e-fcbe-4797-b144-1a7ca2508f50","4rfb5c7e-fcbe-4797-b144-1a7ca2508f3f"],"access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null},"is_invitation_id":false,"sso_user_type":0} } } } }, "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 - Success Response for update reader": { "summary": "This is an example for 200 status, success response.", "value": {"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 - Invalid reader ID": { "summary": "Kindly verify your readers Id and perform the operation again. This seems to be an error while finding the reader, find your reader Id from /v2/Readers.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The reader id is invalid.","error_code":null,"custom_data":null}],"warnings":null,"information":null} }, "Readers - Required Access Scope": { "summary": "Here you should add access_scope within request body parameter. This may consist of access_level, categories, project_versions, languages.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The reader id is invalid.","error_code":null,"custom_data":null}],"warnings":null,"information":null} }, "Readers - Required associated reader groups": { "summary": "Here you should add associated reader groups within request body parameter.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The AssociatedReaderGroups 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": [ ] } ] }, "delete": { "tags": [ "Readers" ], "summary": "Deletes a reader from the project", "operationId": "deleteReader", "parameters": [ { "name": "readerId", "in": "path", "description": "The ID of the reader to delete. Fetch via `GET /v2/readers`.", "required": true, "schema": { "type": "string" }, "example": "91b70808-3d15-45e0-a641-f03e2a0b0efd" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Readers - Success Response for delete reader": { "summary": "This is an example for 200 status, success response.", "value": {"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 - Invalid reader ID": { "summary": "Kindly verify your readers Id and perform the operation again. This seems to be an error while finding the reader, find your reader Id from /v2/Readers.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The reader id is invalid.","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" } } } }, "403": { "description": "The caller's plan, license, or role does not include this feature or permission.", "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": [ ] } ] } }, "/v2/Readers/JWT": { "delete": { "tags": [ "Readers" ], "summary": "Deletes JWT readers from the project", "operationId": "deleteJWTReaders", "parameters": [ { "name": "emailIds", "in": "query", "description": "Email addresses of the JWT readers to remove from analytics (marked as unknown).", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "JWT Readers - Success Response for delete JWT reader": { "summary": "This is an example for 200 status, success response.", "value": {"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": { "Failed to delete JWT readers": { "summary": "This is an example for 400 status, failure response.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Failed to delete JWT readers.","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" } } } }, "403": { "description": "The caller's plan, license, or role does not include this feature or permission.", "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": [ ] } ] } }, "/v2/Teams": { "get": { "tags": [ "Teams" ], "summary": "Gets all team accounts", "description": "Returns the project's team accounts (portal users) with their portal role and last-login timestamp. Uses skip/take pagination — supply `skip = take * (page - 1)` to navigate through pages.\r\nUse the returned `userId` field as the input to `PUT /v2/teams/{userId}/portal`, `PUT /v2/teams/{userId}/content`, and `PUT /v2/teams/{userId}/groups`.\r\nSafe to retry; idempotent.", "operationId": "getAllTeamAccounts", "parameters": [ { "name": "skip", "in": "query", "description": "Number of records to skip (offset). Default: 0.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "example": 0 }, { "name": "take", "in": "query", "description": "Number of records to return per page. Default: 20.", "schema": { "type": "integer", "format": "int32", "default": 20 }, "example": 20 } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAccountSummaryCustomerListCustomerApiResponse" }, "examples": { "Mixed team — owner, editor, draft writer": { "summary": "A typical project team with three accounts: an Owner, an Editor, and a Draft Writer. Use each `userId` as the input to other Team endpoints.", "value": {"result":[{"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","portal_role":"Owner","last_login_at":"2026-05-18T08:22:00Z"},{"user_id":"a7f2c5e1-8d4b-4cba-9f10-2b3c4d5e6f70","first_name":"Anita","last_name":"Rao","email_id":"anita.rao@example.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","portal_role":"Editor","last_login_at":"2026-05-17T16:05:00Z"},{"user_id":"c8d9e0f1-a2b3-4c4d-e5f6-a7b8c9d0e1f2","first_name":"Marcus","last_name":"Lee","email_id":"marcus.lee@example.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","portal_role":"Draft Writer","last_login_at":null}],"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "Solo project — owner only": { "summary": "A new project with just the owner account. `lastLoginAt` is populated; the result array has a single entry.", "value": {"result":[{"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"Peter","last_name":"Jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","portal_role":"Owner","last_login_at":"2026-05-18T08:22:00Z"}],"extension_data":null,"success":true,"errors":[],"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" } } } }, "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": [ ] } ] }, "post": { "tags": [ "Teams" ], "summary": "Adds a new team account", "description": "Creates a new team account (portal user). The user receives an invitation email unless they are SSO (in which case the account is provisioned but inactive until their first SSO sign-in — the response carries a `projectInvitationId` rather than a `userId`).\r\nFor SSO accounts, `invitedBy` is required and must be an existing team account ID (not a reader).\r\n**Not idempotent** — check `GET /v2/teams/email-exists?emailId=…` before retrying after a 5xx.", "operationId": "addTeamAccount", "requestBody": { "description": "Team account creation payload. `emailId` is required. For SSO users, `invitedBy` (a team account ID — fetch via `GET /v2/teams`) is also required.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddTeamAccountCustomer" } ], "description": "Request to add a new team account user" }, "examples": { "Team Account - Add a new team account with content permission level None.": { "summary": "Here you can add new team account with content permission and access level as None.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Category.": { "summary": "Here you can add new team account with content permission and access level to Category.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":1,"categories":[{"project_version_id":"4f44c7e-fcbe-4797-b144-1a7ca2508444","category_id":"8345c7e-fcbe-4797-b144-1a7ca25034","language_code":"en"}],"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Language.": { "summary": "Here you can add new team account with content permission and access level to Language.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"232c7e-fcbe-4797-b144-1a7ca250345","language_code":"en"}]}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Project.": { "summary": "Here you can add new team account with content permission and access level to Project.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Version.": { "summary": "Here you can add new team account with content permission and access level to Version.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddTeamAccountCustomer" } ], "description": "Request to add a new team account user" }, "examples": { "Team Account - Add a new team account with content permission level None.": { "summary": "Here you can add new team account with content permission and access level as None.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Category.": { "summary": "Here you can add new team account with content permission and access level to Category.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":1,"categories":[{"project_version_id":"4f44c7e-fcbe-4797-b144-1a7ca2508444","category_id":"8345c7e-fcbe-4797-b144-1a7ca25034","language_code":"en"}],"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Language.": { "summary": "Here you can add new team account with content permission and access level to Language.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"232c7e-fcbe-4797-b144-1a7ca250345","language_code":"en"}]}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Project.": { "summary": "Here you can add new team account with content permission and access level to Project.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Version.": { "summary": "Here you can add new team account with content permission and access level to Version.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddTeamAccountCustomer" } ], "description": "Request to add a new team account user" }, "examples": { "Team Account - Add a new team account with content permission level None.": { "summary": "Here you can add new team account with content permission and access level as None.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Category.": { "summary": "Here you can add new team account with content permission and access level to Category.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":1,"categories":[{"project_version_id":"4f44c7e-fcbe-4797-b144-1a7ca2508444","category_id":"8345c7e-fcbe-4797-b144-1a7ca25034","language_code":"en"}],"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Language.": { "summary": "Here you can add new team account with content permission and access level to Language.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"232c7e-fcbe-4797-b144-1a7ca250345","language_code":"en"}]}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Project.": { "summary": "Here you can add new team account with content permission and access level to Project.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Version.": { "summary": "Here you can add new team account with content permission and access level to Version.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddTeamAccountCustomer" } ], "description": "Request to add a new team account user" }, "examples": { "Team Account - Add a new team account with content permission level None.": { "summary": "Here you can add new team account with content permission and access level as None.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":false,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":0,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Category.": { "summary": "Here you can add new team account with content permission and access level to Category.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":1,"categories":[{"project_version_id":"4f44c7e-fcbe-4797-b144-1a7ca2508444","category_id":"8345c7e-fcbe-4797-b144-1a7ca25034","language_code":"en"}],"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Language.": { "summary": "Here you can add new team account with content permission and access level to Language.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":4,"categories":null,"project_versions":null,"languages":[{"project_version_id":"232c7e-fcbe-4797-b144-1a7ca250345","language_code":"en"}]}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Project.": { "summary": "Here you can add new team account with content permission and access level to Project.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":3,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":null} }, "Team Account - Add a new team account with content permission level as Version.": { "summary": "Here you can add new team account with content permission and access level to Version.", "value": {"email_id":"peterjone@mail.com","first_name":"Peter","last_name":"Jone","invited_by":"844fb5c7e-fcbe-4797-b144-1a7ca2508f43","is_sso_user":true,"scheme_name":null,"skip_sso_invitation_email":true,"associated_portal_role_id":"8db42c7e-fcbe-4797-b144-1a7ca2508453","content_permissions":[{"associated_content_role_id":"33b5c7e-fcbe-4797-b144-1a7ca2508f44","access_scope":{"access_level":2,"categories":null,"project_versions":null,"languages":null}}],"associated_groups":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/AddUserDataCustomerApiResponse" }, "examples": { "Standard team account created": { "summary": "The new team account is created with an active `userId`. Use this `userId` in subsequent calls to /v2/teams/{userId}/portal or /v2/teams/{userId}/content to update roles.", "value": {"result":{"id":"40d55ebb-d2ab-4327-99d0-0e166f8ce6c2"},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} }, "SSO team account — pending invitation": { "summary": "For SSO users, the returned `id` is a `projectInvitationId` rather than a `userId`. The team account is only fully provisioned after the invitee completes their first SSO sign-in.", "value": {"result":{"id":"9bd4c220-5a1f-4b2e-8d7c-1e2f3a4b5c6d"},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[{"extension_data":null,"description":"SSO invitation sent. The team account will be activated on first sign-in."}]} } } } } }, "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": { "Existing team member": { "summary": "The user is an exixsting team member. Kindly change your mail Id to add a new to your team account.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"User already associated with the project as a reader or team member.","error_code":null,"custom_data":null}],"warnings":[],"information":[]} }, "Invited By field is missing.": { "summary": "Kindly add the invitedBy field in the body of the content. You can find the invitedBy Id in the /V2/team/email-exists.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The InvitedBy field is required.","error_code":null,"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" } } } }, "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": [ ] } ] } }, "/v2/Teams/{userId}": { "get": { "tags": [ "Teams" ], "summary": "Gets complete team account details by ID", "operationId": "getUserById", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the team account. Fetch via `GET /v2/teams`.", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteUserInfoCustomerCustomerApiResponse" }, "examples": { "Teams - Success status Response": { "summary": "Here you can verify the user portal role, content role,and group associated by the user.", "value": {"result":{"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8","first_name":"peter","last_name":"jone","email_id":"peterjone@mail.com","profile_logo_url":"https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D","last_login_at":"2024-06-13T14:30:00","portal_role":{"role_id":"c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8","role_name":" Owner"},"content_roles":[{"version_access":null,"language_access":null,"category_access":null,"article_access":null,"access_scope_level":3,"role_id":"62810dc1-2d21-422e-bdfb-c3daebf91dd3","role_name":"Editor"}],"associated_groups":[{"id":"c08e52df-1de9-44e7-8c02-be0e41826c24","title":"MyGroupName","description":"This is my group description.","content_role_infos":null}]},"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Teams - Invalid User Id": { "summary": " Here the user Id is not valid, go to /v2/Teams/email-exists for finding the user Id. Kindly verify that the IsAnSsoUser is false for Non - SSO user. ", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user id does not exist.","error_code":null,"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": [ ] } ] }, "delete": { "tags": [ "Teams" ], "summary": "Deletes a team account with an ID", "operationId": "deleteUser", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the team account to delete. Fetch via `GET /v2/teams`. If the user is still pending invitation, this is the invitation ID.", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerApiBaseResponse" }, "examples": { "Teams - Success response": { "summary": "Here you can view all type of team account. You can find user Id here.", "value": {"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "Teams - Success response": { "summary": "Here you can view all type of team account. You can find user Id here.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"Could not find user with given id","error_code":"","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": [ ] } ] } }, "/v2/Teams/email-exists": { "get": { "tags": [ "Teams" ], "summary": "Checks if an email already exists in the project", "operationId": "emailExists", "parameters": [ { "name": "emailId", "in": "query", "description": "Email address to look up against the project's team accounts.", "required": true, "schema": { "type": "string", "format": "email" }, "example": "peter.jone@example.com" }, { "name": "isAnSsoUser", "in": "query", "description": "When `true`, restricts the lookup to SSO team accounts only.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailExistsResponse" }, "examples": { "Teams - userId Not Found": { "summary": " This shows the userId is not valid. Kindly reverify your userId and perform the task again.", "value": {"data":{"exists":true,"user_id":"f11efc6f-e968-4e95-82eb-85ad61559de8"},"extension_data":null,"success":true,"errors":null,"warnings":[],"information":[]} } } } } }, "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": { "Teams - userId Not Found": { "summary": " This shows the userId is not valid. Kindly reverify your userId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":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" } } } }, "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": [ ] } ] } }, "/v2/Teams/groups": { "get": { "tags": [ "Teams" ], "summary": "Gets all team groups", "operationId": "getAllUserGroups", "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamAccountGroupSummaryCustomerListCustomerApiResponse" }, "examples": { "Teams - Success status Response": { "summary": "Here you can gather all the type of team user group.", "value": {"result":[{"group_id":"c08e52df-1de9-44e7-8c02-be0e41826c24","title":"MyGroupName-1","description":"This is the group description."},{"group_id":"e52dfdf-1de9-44edf7-8c02-be0e41826ff","title":"MyGroupName-2","description":"This is the group description."}],"extension_data":null,"success":true,"errors":[],"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" } } } }, "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": [ ] } ] } }, "/v2/Teams/roles": { "get": { "tags": [ "Teams" ], "summary": "Gets all available roles, including default and custom roles", "operationId": "getAllRoles", "responses": { "200": { "description": "Operation succeeded. Inspect the response envelope's `success` flag and the `result`/`data` payload.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleMetaDataListCustomerApiResponse" }, "examples": { "Teams - Success status Response": { "summary": "Here you can verify diffrent type of roles for the Teams.", "value": {"result":[{"id":"64ced5a8-c2b9-4421-821a-4e32bdfaaecc","title":"Contributor","description":"An editor or draft writer with no admin access.","is_system_role":true,"role_type":0},{"id":"c1b8ae08-78d5-41d9-b3c4-3b0892b05ca8","title":"Owner","description":"","is_system_role":true,"role_type":0},{"id":"264485a9-088e-49bf-b33e-a417e9fa01e5","title":"Admin","description":"Admin has access to everything except billing.","is_system_role":true,"role_type":0},{"id":"88ec9ab0-2355-46b6-8eed-b3ce2cd870a8","title":"None","description":"No content scope assigned. This role can be changed later.","is_system_role":true,"role_type":0},{"id":"62810dc1-2d21-422e-bdfb-c3daebf91dd3","title":"Editor","description":"The editor can manage the articles, categories, drive, workflows, and content reuse.","is_system_role":true,"role_type":1},{"id":"926c7a3c-0fe8-40c8-a96f-f02c95a12d5c","title":"Draft writer","description":"A draft writer can add or edit the articles/category pages but has limitations publishing them.","is_system_role":true,"role_type":1}],"extension_data":null,"success":true,"errors":[],"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" } } } }, "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": [ ] } ] } }, "/v2/Teams/{userId}/content": { "put": { "tags": [ "Teams" ], "summary": "Updates the content roles of an individual team account", "operationId": "editContentRole", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the team account whose content roles are being updated. Fetch via `GET /v2/teams`.", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "requestBody": { "description": "Content role update payload — carries the target content role IDs. Fetch available roles via `GET /v2/teams/roles`.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditContentRoleCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account - Edit Content Role for individual user.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as None. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":0,"categories":[],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Category.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Category. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":1,"categories":[{"project_version_id":"9fa1a-37db-4d15-b06b-0261c60d1v4r","category_id":"23ra1a-37db-4d15-b06b-0261c60d1g4t","language_code":"en"}],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Language.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Language. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":4,"categories":[],"project_versions":[],"languages":[{"project_version_id":"2f29faa-7bdb-4d15-b06b-61c60d183","language_code":"en"}]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Project.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Project. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":3,"categories":[],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Version.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Version. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":2,"categories":[],"project_versions":["dwqd41a-3f7db-4we415-b06b-0261c60d14rf3","sdfda1a-37fdb-4gd15-b06b-0261c60dsdfdsf"],"languages":[]}}],"is_invitation_id":false} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditContentRoleCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account - Edit Content Role for individual user.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as None. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":0,"categories":[],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Category.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Category. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":1,"categories":[{"project_version_id":"9fa1a-37db-4d15-b06b-0261c60d1v4r","category_id":"23ra1a-37db-4d15-b06b-0261c60d1g4t","language_code":"en"}],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Language.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Language. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":4,"categories":[],"project_versions":[],"languages":[{"project_version_id":"2f29faa-7bdb-4d15-b06b-61c60d183","language_code":"en"}]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Project.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Project. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":3,"categories":[],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Version.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Version. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":2,"categories":[],"project_versions":["dwqd41a-3f7db-4we415-b06b-0261c60d14rf3","sdfda1a-37fdb-4gd15-b06b-0261c60dsdfdsf"],"languages":[]}}],"is_invitation_id":false} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditContentRoleCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account - Edit Content Role for individual user.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as None. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":0,"categories":[],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Category.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Category. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":1,"categories":[{"project_version_id":"9fa1a-37db-4d15-b06b-0261c60d1v4r","category_id":"23ra1a-37db-4d15-b06b-0261c60d1g4t","language_code":"en"}],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Language.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Language. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":4,"categories":[],"project_versions":[],"languages":[{"project_version_id":"2f29faa-7bdb-4d15-b06b-61c60d183","language_code":"en"}]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Project.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Project. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":3,"categories":[],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Version.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Version. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":2,"categories":[],"project_versions":["dwqd41a-3f7db-4we415-b06b-0261c60d14rf3","sdfda1a-37fdb-4gd15-b06b-0261c60dsdfdsf"],"languages":[]}}],"is_invitation_id":false} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditContentRoleCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account - Edit Content Role for individual user.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as None. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":0,"categories":[],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Category.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Category. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":1,"categories":[{"project_version_id":"9fa1a-37db-4d15-b06b-0261c60d1v4r","category_id":"23ra1a-37db-4d15-b06b-0261c60d1g4t","language_code":"en"}],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Language.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Language. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":4,"categories":[],"project_versions":[],"languages":[{"project_version_id":"2f29faa-7bdb-4d15-b06b-61c60d183","language_code":"en"}]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Project.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Project. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":3,"categories":[],"project_versions":[],"languages":[]}}],"is_invitation_id":false} }, "Team Account - Edit Content Role for individual user with access scope level as Version.": { "summary": "Here you can edit the existing portal role for individual user with access scope level as Version. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"content_permissions":[{"associated_content_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","access_scope":{"access_level":2,"categories":[],"project_versions":["dwqd41a-3f7db-4we415-b06b-0261c60d14rf3","sdfda1a-37fdb-4gd15-b06b-0261c60dsdfdsf"],"languages":[]}}],"is_invitation_id":false} } } } }, "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": { "Successfully updated content roles": { "summary": "New role updated successfully.", "value": {"result":true,"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "userId not found": { "summary": "Kindly verify the userId and perform the task again.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The invitation id 2e63692d-894b-4a41-90ce-1d0ba87a4b17 does not exist.","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": [ ] } ] } }, "/v2/Teams/{userId}/groups": { "put": { "tags": [ "Teams" ], "summary": "Modifies the groups associated with a team account", "operationId": "editUserGroups", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the team account whose group memberships are being updated. Fetch via `GET /v2/teams`.", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "requestBody": { "description": "Group membership update payload — carries the target `groupIds`. Fetch available groups via `GET /v2/teams/groups`.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditUserGroupsCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account -Edit associated user groups.": { "summary": "Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"associated_groups":["2e29fa1a-37db-4d15-b06b-0261c60d1898","y529fa1a-gedb-4d15-b76b-0261c60d87t8"],"is_invitation_id":true} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditUserGroupsCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account -Edit associated user groups.": { "summary": "Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"associated_groups":["2e29fa1a-37db-4d15-b06b-0261c60d1898","y529fa1a-gedb-4d15-b76b-0261c60d87t8"],"is_invitation_id":true} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditUserGroupsCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account -Edit associated user groups.": { "summary": "Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"associated_groups":["2e29fa1a-37db-4d15-b06b-0261c60d1898","y529fa1a-gedb-4d15-b76b-0261c60d87t8"],"is_invitation_id":true} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditUserGroupsCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account -Edit associated user groups.": { "summary": "Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"associated_groups":["2e29fa1a-37db-4d15-b06b-0261c60d1898","y529fa1a-gedb-4d15-b76b-0261c60d87t8"],"is_invitation_id":true} } } } }, "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": { "Successfully updated associated groups": { "summary": "Updated the group accociated with the user.", "value": {"result":true,"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "associated_groups not found": { "summary": "kindly check the associated_groups id from /V2/Teams/Groups.", "value": {"extension_data":null,"success":true,"errors":[{"extension_data":null,"stack_trace":null,"description":"The AssociatedGroups field 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": [ ] } ] } }, "/v2/Teams/{userId}/portal": { "put": { "tags": [ "Teams" ], "summary": "Updates the portal role of an individual team account", "operationId": "editPortalRole", "parameters": [ { "name": "userId", "in": "path", "description": "The ID of the team account whose portal role is being updated. Fetch via `GET /v2/teams`.", "required": true, "schema": { "type": "string" }, "example": "f11efc6f-e968-4e95-82eb-85ad61559de8" } ], "requestBody": { "description": "Portal role update payload — carries the target `roleId`. Fetch available roles via `GET /v2/teams/roles`.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditPortalRoleCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account - Edit Portal Role for individual user.": { "summary": "Here you can edit the existing portal role for individual user. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"associated_portal_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","is_invitation_id":true} } } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditPortalRoleCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account - Edit Portal Role for individual user.": { "summary": "Here you can edit the existing portal role for individual user. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"associated_portal_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","is_invitation_id":true} } } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditPortalRoleCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account - Edit Portal Role for individual user.": { "summary": "Here you can edit the existing portal role for individual user. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"associated_portal_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","is_invitation_id":true} } } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EditPortalRoleCustomer" } ] }, "example": "Document360

Your Zendesk account is connected to Document360. You can close this window.

", "examples": { "Team Account - Edit Portal Role for individual user.": { "summary": "Here you can edit the existing portal role for individual user. Also to update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.", "value": {"associated_portal_role_id":"2e29fa1a-37db-4d15-b06b-0261c60d1898","is_invitation_id":true} } } } }, "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": { "Successfully updated portal role": { "summary": "New team account created", "value": {"result":true,"extension_data":null,"success":true,"errors":[],"warnings":[],"information":[]} } } } } }, "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": { "userId Not Found": { "summary": "Kindly check the userId and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The user id 40d55ebb-d2ab-4327-99d0-0e166f8ce6c2q does not exist.","error_code":"400","custom_data":null}],"warnings":[],"information":[]} }, "associated_protal_role_id Not Found": { "summary": "Kindly check the associated_protal_role_id and perform the task again.", "value": {"extension_data":null,"success":false,"errors":[{"extension_data":null,"stack_trace":null,"description":"The AssociatedPortalRoleId field 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": [ ] } ] } }, "/v2/Translations/{projectVersionId}/{langCode}": { "get": { "tags": [ "Translations" ], "summary": "Gets articles by translation status", "operationId": "getArticlesForTranslation", "parameters": [ { "name": "projectVersionId", "in": "path", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`.", "required": true, "schema": { "type": "string" }, "example": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234" }, { "name": "langCode", "in": "path", "description": "Language code (for example `en`, `fr`, `de-DE`, `pt-BR`). Use `GET /v2/language/{projectVersionId}` to list the codes enabled for the workspace. Defaults to `en` when omitted.", "required": true, "schema": { "type": "string", "default": "en" }, "example": "en" }, { "name": "status", "in": "query", "description": "Article translation status filter — `0` None, `1` Needs Translation (default), `2` Translated, `3` In Progress.", "schema": { "enum": [ "none", "needTranslation", "translated", "inProgress" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LanguageTranslationOption" } ], "description": "0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress", "default": 1, "x-enumNames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-enum-varnames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-ms-enum": { "name": "LanguageTranslationOption", "modelAsString": 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/GetArticleNotTranslatedResponse" }, "examples": { "Article that need translation": { "summary": "Here are the articleId and categoryId for the article that needs translation for the following language code in the project.", "value": {"data":[{"id":"978a1e16-fd36-4724-b63f-c313a059a30b","category_id":"978a1e16-fd36-4724-b63f-c313a059a30b"},{"id":"978a1e16-fd36-4724-b63f-c313a059a30b","category_id":"978a1e16-fd36-4724-b63f-c313a059a30b"},{"id":"978a1e16-fd36-4724-b63f-c313a059a30b","category_id":"978a1e16-fd36-4724-b63f-c313a059a30b"}],"extension_data":null,"success":true,"errors":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": { "AIAdditionalFeedbackInfo": { "type": "object", "properties": { "need_more_information": { "type": "boolean", "description": "User needs more information than what was provided in the AI response." }, "difficult_to_understand": { "type": "boolean", "description": "The AI response was difficult for the user to understand." }, "irrelevant_content": { "type": "boolean", "description": "The AI response was not relevant to the user's query." }, "incorrect_source_reference": { "type": "boolean", "description": "The source references in the AI response were incorrect or misleading." }, "missing_information": { "type": "boolean", "description": "Important information was missing from the AI response." }, "dont_like_style": { "type": "boolean", "description": "The user did not like the style of the AI response." }, "others": { "type": "boolean", "description": "The user's feedback does not fall under the predefined categories." }, "comments": { "type": "boolean", "description": "Indicates whether the user has provided additional comments." } }, "additionalProperties": false }, "AIAssistiveSearch": { "type": "object", "properties": { "prompt": { "type": "string", "nullable": true }, "result": { "type": "string", "nullable": true }, "reference_articles": { "type": "array", "items": { "$ref": "#/components/schemas/VectorSearchReferenceArticles" }, "nullable": true }, "limit_exceeded": { "type": "boolean" }, "analytics_id": { "type": "string", "nullable": true }, "remaining_credits": { "type": "integer", "format": "int32" }, "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "Round-trip extension data for forward-compat fields not modelled here.", "nullable": true }, "context": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseContext" } ], "description": "Optional response-level context (e.g. caller reference for log correlation).", "nullable": true }, "success": { "type": "boolean", "description": "True when the request succeeded. Always inspect this before consuming the success-shape fields.", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BaseError" }, "description": "List of structured errors. Populated when Document360.Core.Messages.Core.BaseResponse.success is false.", "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BaseWarning" }, "description": "List of non-fatal warnings — the request succeeded, but with caveats worth surfacing to the user.", "nullable": true }, "information": { "type": "array", "items": { "$ref": "#/components/schemas/BaseInformation" }, "description": "Informational messages — context the SPA might use (e.g. fallback logic, skipped operations).", "nullable": true }, "feature_explorer_status": { "allOf": [ { "$ref": "#/components/schemas/FeatureExplorerStatus" } ], "description": "Onboarding/feature-explorer status payload, surfaced via response interceptors.", "nullable": true }, "custom_page_element": { "allOf": [ { "$ref": "#/components/schemas/UIElement" } ], "description": "UI element directive returned alongside the response when the SPA should render an inline tip or banner.", "nullable": true } }, "additionalProperties": false }, "AIAssistiveSearchRequest": { "type": "object", "properties": { "prompt": { "type": "string", "nullable": true }, "version_id": { "type": "string", "nullable": true }, "language_code": { "type": "string", "nullable": true }, "enable_citation": { "type": "boolean" }, "response_tone": { "allOf": [ { "$ref": "#/components/schemas/ResponseTone" } ], "description": "Optional per-call override for Eddy response tone. When omitted, the project-level\r\nAI search setting is used. Allowed values: Default, Professional, Friendly, Casual,\r\nStraightforward, Confident.", "nullable": true }, "response_length": { "allOf": [ { "$ref": "#/components/schemas/ResponseLength" } ], "description": "Optional per-call override for Eddy response length. When omitted, the project-level\r\nAI search setting is used. Allowed values: Default, LongAndDetailed, ShortAndConcise.", "nullable": true } }, "additionalProperties": false }, "AccessScopeCustomerV2": { "type": "object", "properties": { "access_level": { "enum": [ "none", "category", "version", "project", "language", "article", "workspace", "guides", "guideCategories", "knowledgeBaseDisabled" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccessScopeLevel" } ], "description": "The access level of the reader group. 0-None, 1-Category, 2-Version, 3-Project, 4-Language", "x-enumNames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "x-enum-varnames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "x-ms-enum": { "name": "AccessScopeLevel", "modelAsString": true } }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategorySummaryCustomerV2" }, "description": "List of category scope objects.", "nullable": true }, "project_versions": { "type": "array", "items": { "type": "string" }, "description": "List of project version IDs the reader has access to.", "nullable": true }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageSummaryCustomer" }, "description": "List of language scope objects.", "nullable": true } }, "additionalProperties": false, "description": "V2 access scope — describes what content a reader or reader group can see. The shape of the scope depends on Document360.Core.Models.Public.Readers.AccessScopeCustomerV2.AccessLevel: category-level scopes use Document360.Core.Models.Public.Readers.AccessScopeCustomerV2.Categories, workspace-level scopes use Document360.Core.Models.Public.Readers.AccessScopeCustomerV2.ProjectVersions, and language-level scopes use Document360.Core.Models.Public.Readers.AccessScopeCustomerV2.Languages." }, "AccessScopeLevel": { "enum": [ "none", "category", "version", "project", "language", "article", "workspace", "guides", "guideCategories", "knowledgeBaseDisabled" ], "type": "string", "description": "This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage, 5 - Article, 6 - Workspace, 7 - Guides, 8 - GuideCategories, 9 - KnowledgeBaseDisabled", "x-enumNames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "x-enum-varnames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "x-ms-enum": { "name": "AccessScopeLevel", "modelAsString": true } }, "AddCategoryRequest": { "required": [ "name", "project_version_id" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "The name of the category" }, "project_version_id": { "minLength": 1, "type": "string", "description": "The ID of the project version where category has to be added" }, "order": { "type": "integer", "description": "The position inside the parent category", "format": "int32" }, "parent_category_id": { "type": "string", "description": "The ID of the parent category. If empty, it will be added as top level category)", "nullable": true }, "content": { "type": "string", "description": "The content of the article, for any Editor type, use this property", "nullable": true }, "category_type": { "enum": [ "default", "customContent", "linksToArticle" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "Defines what a category represents in the documentation hierarchy.", "x-enumNames": [ "Default", "CustomContent", "LinksToArticle" ], "x-enum-varnames": [ "Default", "CustomContent", "LinksToArticle" ], "x-ms-enum": { "name": "CategoryType", "modelAsString": true } }, "user_id": { "type": "string", "description": "The ID of the team account", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG", "default": null, "nullable": true }, "slug": { "type": "string", "description": "Optional custom URL-friendly slug for the category. If not provided, a slug will be auto-generated from the name.\r\nWhen provided, the slug must be unique within the project version, otherwise an error will be returned.", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AddCategoryResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CategorySimpleData" } ], "description": "added category response 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 }, "AddMediaFileResponseCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFileMetaDataCustomer" }, "description": "Bulk response of file details", "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 }, "AddMediaFolderRequestCustomer": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the folder", "nullable": true }, "parent_folder_id": { "type": "string", "description": "The parent media folder ID", "nullable": true }, "user_id": { "type": "string", "description": "The ID of the user", "nullable": true }, "order": { "type": "integer", "description": "The order of the folder", "format": "int32" } }, "additionalProperties": false }, "AddReaderGroupRequestV2": { "required": [ "access_scope", "title" ], "type": "object", "properties": { "title": { "minLength": 1, "pattern": "^[^~`!@#$%^&*)(+=|\\]\\[{};:?/>'.,]*$", "type": "string", "description": "The name of the reader group" }, "description": { "type": "string", "description": "Access level of the reader group", "nullable": true }, "associated_readers": { "type": "array", "items": { "type": "string" }, "description": "Description of the reader group", "nullable": true }, "access_scope": { "allOf": [ { "$ref": "#/components/schemas/AddUpdateAccessScopeCustomerV2" } ], "description": "List of reader IDs to be associated with the reader group" }, "associated_invited_sso_users": { "type": "array", "items": { "type": "string" }, "description": "List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.", "nullable": true } }, "additionalProperties": false }, "AddReaderRequestV2": { "required": [ "email_id", "invited_by" ], "type": "object", "properties": { "first_name": { "type": "string", "description": "The first name of the reader", "nullable": true }, "last_name": { "type": "string", "description": "The last name of the reader", "nullable": true }, "email_id": { "minLength": 1, "type": "string", "description": "The Email address of the reader", "format": "email" }, "associated_reader_groups": { "type": "array", "items": { "type": "string" }, "description": "List of reader group IDs", "nullable": true }, "access_scope": { "allOf": [ { "$ref": "#/components/schemas/AddUpdateAccessScopeCustomerV2" } ], "description": "If access scope is not given, then 0-None access level will be assigned", "nullable": true }, "is_sso_user": { "type": "boolean", "description": "Specify if the reader is a Single Sign-On user or not" }, "scheme_name": { "type": "string", "description": "Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.", "nullable": true }, "skip_sso_invitation_email": { "type": "boolean", "description": "If the value is true, then the invitation email will not be sent to the reader. Applicable only for a Single Sign-On reader." }, "invited_by": { "minLength": 1, "type": "string", "description": "The ID of an existing team account. The name of this team account will be mentioned in the invitation email." } }, "additionalProperties": false }, "AddTeamAccountCustomer": { "required": [ "associated_portal_role_id", "content_permissions", "email_id", "invited_by" ], "type": "object", "properties": { "email_id": { "minLength": 1, "type": "string", "description": "The email address of the team account", "format": "email" }, "first_name": { "type": "string", "description": "First name of the team account", "nullable": true }, "last_name": { "type": "string", "description": "Last name of the team account", "nullable": true }, "invited_by": { "minLength": 1, "type": "string", "description": "The ID of an existing team account. To get the id, please refer GET **/v2/Teams** endpoint" }, "is_sso_user": { "type": "boolean", "description": "Set this to true, if you are adding an SSO user" }, "scheme_name": { "type": "string", "description": "Specify to add the reader to the specific scheme name, if the reader is a Single Sign-On user. If the scheme name is not provided, then the reader will be added to the default scheme.", "nullable": true }, "skip_sso_invitation_email": { "type": "boolean", "description": "Set this to true, if you would like to avoid sending an invitation email to the newly added team account.\r\nThis property is applicable only when adding a SSO user." }, "associated_portal_role_id": { "minLength": 1, "type": "string", "description": "The associated portal role id. To get the list of portal roles refer /teams/roles endpoint." }, "content_permissions": { "type": "array", "items": { "$ref": "#/components/schemas/ContentPermissionCustomer" }, "description": "The content level permissions for the newly added team account" }, "associated_groups": { "type": "array", "items": { "type": "string" }, "description": "A list of group ids to which the team account has to be added. Please refer /teams/groups endpoint to get the available groups.", "nullable": true } }, "additionalProperties": false, "description": "Request to add a new team account user" }, "AddUpdateAccessScopeCustomerV2": { "required": [ "access_level" ], "type": "object", "properties": { "access_level": { "enum": [ "none", "category", "version", "project", "language", "article", "workspace", "guides", "guideCategories", "knowledgeBaseDisabled" ], "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", "KnowledgeBaseDisabled" ], "x-enum-varnames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "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" }, "AddUserData": { "type": "object", "properties": { "id": { "type": "string", "description": "Newly added user Id", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AddUserDataCustomerApiResponse": { "type": "object", "properties": { "result": { "allOf": [ { "$ref": "#/components/schemas/AddUserData" } ], "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `true`.", "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, "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." }, "AllFilesWithCountCustomer": { "type": "object", "properties": { "all_files": { "type": "array", "items": { "$ref": "#/components/schemas/DeletedandStarredMetaDataCustomer" }, "description": "Search file items from drive", "nullable": true }, "count": { "type": "integer", "description": "Total file count", "format": "int32" } }, "additionalProperties": false }, "AllFilesWithCountResponseCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AllFilesWithCountCustomer" } ], "description": "Search result meta 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 }, "ApiDefinitionInforamtionCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the API reference.", "nullable": true, "readOnly": true }, "name": { "type": "string", "description": "The display name of the API reference (typically the spec's title).", "nullable": true }, "upload_type": { "type": "string", "description": "How the spec was imported — for example a file upload or a hosted URL.", "nullable": true } }, "additionalProperties": false, "description": "Compact descriptor for one API reference imported into a workspace — ID, display name, and source type (file upload vs URL)." }, "ApiDocsImportDataCustomer": { "type": "object", "properties": { "categories_created": { "type": "integer", "description": "Total category created", "format": "int32" }, "articles_created": { "type": "integer", "description": "Total article created", "format": "int32" }, "api_reference_id": { "type": "string", "description": "Api reference ID", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorAndWarningsData" }, "description": "Error log response", "nullable": true }, "alerts": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorAndWarningsData" }, "description": "Alerts log response", "nullable": true }, "deleted_endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/DeletedEndpointInfoCustomer" }, "description": "Endpoint articles this operation removed, or would remove. Mirrors the\r\n`deleted_endpoints` array of the synchronous `PUT /v2/apireferences` resync, so a\r\ncompleted poll of `GET /v2/apireferences/jobs/{id}` carries the same detail.", "nullable": true }, "background_task_id": { "type": "string", "description": "Id of the background job, on the async import/resync routes only. Poll\r\n`GET /v2/apireferences/jobs/{background_task_id}` with it.", "nullable": true }, "is_processing": { "type": "boolean", "description": "`true` while the job is still running, `false` once it has finished. Async routes\r\n only; omitted when unset.", "nullable": true } }, "additionalProperties": false, "description": "Summary of an API spec import — what was generated and any non-fatal validation findings." }, "ApiDocsResyncDataCustomer": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorAndWarningsData" }, "description": "Error log response", "nullable": true }, "alerts": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorAndWarningsData" }, "description": "Alerts log response", "nullable": true }, "categories_created": { "type": "integer", "description": "Total categories created", "format": "int32" }, "articles_created": { "type": "integer", "description": "Total articles created", "format": "int32" }, "deleted_endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/DeletedEndpointInfoCustomer" }, "description": "Endpoints that will be removed by this spec update.\r\nPopulated only on dry-run (ForceImport = false). Pass ForceImport = true to confirm.", "nullable": true } }, "additionalProperties": false, "description": "Summary of an API spec resync operation — what was generated, what would be removed, and any non-fatal validation findings." }, "ApiDocumentationImportResponseCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApiDocsImportDataCustomer" } ], "description": "Import summary — counts, generated `apiReferenceId`, and validation results.", "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, "description": "Response wrapper for `POST /v2/apireferences` — carries the import summary plus any errors/alerts surfaced during processing." }, "ApiDocumentationResyncResponseCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ApiDocsResyncDataCustomer" } ], "description": "Resync summary — counts, validation results, and pending deletions.", "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, "description": "Response wrapper for `PUT /v2/apireferences` — carries the resync summary plus any errors/alerts and (in dry-run mode) the list of endpoint articles that would be removed." }, "ApiErrorAndWarningsData": { "type": "object", "properties": { "message": { "type": "string", "description": "Descriptive message of the problem.", "nullable": true }, "pointer": { "type": "string", "description": "JSON pointer to the path inside the spec where the problem occurred.", "nullable": true } }, "additionalProperties": false, "description": "One error or alert raised while parsing an imported OpenAPI/Swagger spec." }, "ApiLogs": { "type": "object", "properties": { "message": { "type": "string", "description": "Descriptive message represent the problem occur", "nullable": true }, "pointer": { "type": "string", "description": "Path where the problem occur", "nullable": true } }, "additionalProperties": false }, "ApiReferenceLogsDataCustomer": { "type": "object", "properties": { "logs_id": { "type": "string", "description": "The API reference Log ID", "nullable": true }, "user_name": { "type": "string", "description": "The name of the team account", "nullable": true }, "user_id": { "type": "string", "description": "The ID of the team account", "nullable": true }, "title": { "type": "string", "description": "Status of API reference", "nullable": true }, "modified_at": { "type": "string", "description": "Modified date/time", "format": "date-time", "readOnly": true }, "error_count": { "type": "integer", "description": "Total errors count", "format": "int32" }, "alerts_count": { "type": "integer", "description": "Total alerts count", "format": "int32" } }, "additionalProperties": false, "description": "One log entry for an API reference import or resync — author, timestamp, status, and validation counts." }, "ApiReferenceLogsWrapResponseCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiReferenceLogsDataCustomer" }, "description": "The log entries for this API reference.", "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, "description": "Response wrapper for `GET /v2/apireferences/{apiReferenceId}/Logs` — paginated list of import/resync log entries for an API reference." }, "ApiReferencePublishRequestCustomer": { "required": [ "api_reference_id", "project_version_id", "user_id" ], "type": "object", "properties": { "api_reference_id": { "minLength": 1, "type": "string", "description": "The ID of the API reference to publish." }, "project_version_id": { "minLength": 1, "type": "string", "description": "The ID of the workspace (also called project version). Fetch via `GET /v2/projectversions`." }, "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account performing the publish. Fetch via `GET /v2/teams`." } }, "additionalProperties": false, "description": "Payload for `POST /v2/apireferences/publish` — publishes the endpoint articles imported from an API reference." }, "ArticleAccessInfo": { "type": "object", "properties": { "article_name": { "type": "string", "nullable": true }, "category_name": { "type": "string", "nullable": true }, "category_id": { "type": "string", "nullable": true }, "language_id": { "type": "string", "nullable": true }, "language_name": { "type": "string", "nullable": true }, "language_code": { "type": "string", "nullable": true }, "version_name": { "type": "string", "nullable": true }, "version_id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "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 } }, "ArticleDataBySlugCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the document.", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "The title of the document.", "nullable": true }, "content": { "type": "string", "description": "If the article editor is **Markdown**, then the article content will be present in this property", "nullable": true }, "html_content": { "type": "string", "description": " If the article editor is **WYSIWYG (HTML)**, then the content will be present in this property. \r\n**Note**: Markdown editor will also have HTML content (read-only).", "nullable": true }, "category_id": { "type": "string", "description": "The ID of the article's parent category", "nullable": true }, "project_version_id": { "type": "string", "description": "The ID of the project version where the article is located", "nullable": true }, "version_number": { "type": "integer", "description": "The currently fetched version number of the article", "format": "int32" }, "public_version": { "type": "integer", "description": "The currently published version number of the article", "format": "int32", "readOnly": true }, "latest_version": { "type": "integer", "description": "The latest version number of the article", "format": "int32", "readOnly": true }, "enable_rtl": { "type": "boolean", "description": "Returns true if right-to-left text alignment is enabled for the selected language for the document." }, "hidden": { "type": "boolean", "description": "`False` indicates that the article is visible on the site" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "order": { "type": "integer", "description": "The position inside the parent category", "format": "int32" }, "created_by": { "type": "string", "description": "The position of the document within its parent category.", "nullable": true }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/ContributorInfoCustomer" }, "description": "The list of contributors who have authored or modified the document. Each object includes contributor details such as name, email, and role.", "nullable": true }, "created_at": { "type": "string", "description": "The date and time when the document was created.", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The date and time when the document was last modified.", "format": "date-time", "readOnly": true }, "slug": { "type": "string", "description": "The slug (URL-friendly identifier) of the document.", "nullable": true, "readOnly": true }, "is_fall_back_content": { "type": "boolean", "description": "Returns true if the document is a fallback from the default language when the requested language version is unavailable." }, "stale_status": { "allOf": [ { "$ref": "#/components/schemas/StaleStatus" } ], "description": "Fresh - Article is up-to-date\r\nStale - Article requires review", "nullable": true }, "description": { "type": "string", "description": "A short description or summary of the document.", "nullable": true }, "category_type": { "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "0 - Folder, 1 - Page, 2 - Index", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The editor type used for the document.\r\nValid values: 0 - Markdown, 1 - WYSIWYG(HTML), 2 - Advanced WYSIWYG", "nullable": true }, "is_shared_article": { "type": "boolean", "description": "Returns true if the document is shared through private sharing." }, "translation_option": { "enum": [ "none", "needTranslation", "translated", "inProgress" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LanguageTranslationOption" } ], "description": "The translation status of the document.\r\nValid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress", "x-enumNames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-enum-varnames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-ms-enum": { "name": "LanguageTranslationOption", "modelAsString": true } }, "url": { "type": "string", "description": "The fully qualified public URL of the document.", "nullable": true }, "current_workflow_status_id": { "type": "string", "description": "The current workflow status ID of the document.", "nullable": true }, "lang_code": { "type": "string", "description": "The language code of the document.", "nullable": true }, "available_languages": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableLanguageInfo" }, "description": "Lists the languages in which the document is available, along with their translation status and URL. Each object includes:", "nullable": true }, "settings": { "allOf": [ { "$ref": "#/components/schemas/DocumentSettings" } ], "description": "Contains SEO settings and exclusion preferences for the document.", "nullable": true }, "security_visibility": { "enum": [ "public", "private" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SecurityVisibility" } ], "description": "Indicates the visibility level of the article.Valid values are: \r\n0 - Public(accessible to all readers)\r\n1 - Private(accessible only to authenticated users or specific teams).", "x-enumNames": [ "Public", "Private" ], "x-enum-varnames": [ "Public", "Private" ], "x-ms-enum": { "name": "SecurityVisibility", "modelAsString": true } }, "custom_fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "Custom field values associated with the article. Returned for V1 callers only.", "nullable": true }, "custom_fields_data": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Custom field values as a compact key-value map. Returned for V2 callers only.\r\nKey is the field label. Value is in its native type: string, number, boolean, or a comma-separated string of labels for multi-select.", "nullable": true } }, "additionalProperties": false }, "ArticleMatchedData": { "type": "object", "properties": { "hits": { "type": "array", "items": { "$ref": "#/components/schemas/Hit" }, "description": "The list of articles that matched the search query.", "nullable": true }, "nb_hits": { "type": "integer", "description": "The number of hits (articles) matched by the query.", "format": "int32", "nullable": true }, "page": { "type": "integer", "description": "The position of the current page (zero-based).", "format": "int32", "nullable": true }, "nb_pages": { "type": "integer", "description": "The number of returned pages. Calculation is based on the total number of hits (nbHits) divided by the number of hits per page (hitsPerPage), rounded up to the nearest integer.", "format": "int32", "nullable": true }, "hits_per_page": { "type": "integer", "description": "Maximum number of hits (articles) per page.", "format": "int32", "nullable": true }, "processing_time_ms": { "type": "integer", "description": "The time the server took to process the request, in milliseconds. This doesn’t include network time.", "format": "int32", "nullable": true }, "query": { "type": "string", "description": "The query used to search the articles.", "nullable": true } }, "additionalProperties": false }, "ArticleSettingCustomer": { "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": "`True` indicates that comments are allowed in the article" }, "show_table_of_contents": { "type": "boolean", "description": "`True` indicates that Table of Contents are shown in the article" }, "show_published_version_log": { "type": "boolean", "description": "Whether the published version history log is shown for this article (KB site / export PDF). On read this is always a concrete boolean — the article-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 (article 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 article", "nullable": true }, "status_indicator": { "enum": [ "none", "new", "update", "custom" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusIndicator" } ], "description": "The status of the article: 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` indicates that the article will not appear in the Knowledge base search results" }, "exclude_from_ai_search": { "type": "boolean" }, "exclude_from_external_search": { "type": "boolean" }, "related_articles": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedArticleData" }, "description": "List of related articles associated to the article", "nullable": true }, "is_acknowledgement_enabled": { "type": "boolean" }, "custom_fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "Custom field values associated with the article", "nullable": true } }, "additionalProperties": false, "description": "Per-article settings — slug, SEO metadata, comment policy, status indicator, custom fields, and other publishing-time controls. Returned by `GET /v2/articles/{articleId}/{langCode}/settings`." }, "ArticleSettingCustomerResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "Url of the article", "nullable": true }, "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": "`True` indicates that comments are allowed in the article" }, "show_table_of_contents": { "type": "boolean", "description": "`True` indicates that Table of Contents are shown in the article" }, "show_published_version_log": { "type": "boolean", "description": "Whether the published version history log is shown for this article (KB site / export PDF). On read this is always a concrete boolean — the article-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 (article 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 article", "nullable": true }, "status_indicator": { "enum": [ "none", "new", "update", "custom" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusIndicator" } ], "description": "The status of the article: 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` indicates that the article will not appear in the Knowledge base search results" }, "exclude_from_ai_search": { "type": "boolean" }, "exclude_from_external_search": { "type": "boolean" }, "related_articles": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedArticleData" }, "description": "List of related articles associated to the article", "nullable": true }, "is_acknowledgement_enabled": { "type": "boolean" }, "custom_fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "Custom field values associated with the article", "nullable": true } }, "additionalProperties": false }, "ArticleSimpleDataCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the article", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "The article title", "nullable": true }, "public_version": { "type": "integer", "description": "The article version number(revision) that is currently published", "format": "int32", "readOnly": true }, "latest_version": { "type": "integer", "description": "The latest version number of this article", "format": "int32", "readOnly": true }, "language_code": { "type": "string", "description": "**Deprecated:** This property is deprecated and will be removed in a future version of the API. Please use /v2/Language/{projectVersionId} to fetch the languages in the project version\n\nThe default language code", "nullable": true, "deprecated": true }, "hidden": { "type": "boolean", "description": "Indicates if the article is visible on the site" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "order": { "type": "integer", "description": "The position of the article inside the parent category", "format": "int32" }, "slug": { "type": "string", "description": "The slug of the article", "nullable": true, "readOnly": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2", "nullable": true }, "translation_option": { "enum": [ "none", "needTranslation", "translated", "inProgress" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LanguageTranslationOption" } ], "description": "The translation status of the document.\r\nValid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress", "x-enumNames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-enum-varnames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-ms-enum": { "name": "LanguageTranslationOption", "modelAsString": true } }, "is_shared_article": { "type": "boolean", "description": "`True` indicates that the article is shared" }, "created_at": { "type": "string", "description": "Article created date time", "format": "date-time", "nullable": true, "readOnly": true }, "modified_at": { "type": "string", "description": "Article modified date time", "format": "date-time", "nullable": true, "readOnly": true }, "current_workflow_status_id": { "type": "string", "description": "Current Workflow status of the article", "nullable": true } }, "additionalProperties": false, "description": "Compact article representation — title, slug, current/latest version numbers, hierarchy position, and basic settings. Returned in list endpoints and create/bulk-create responses where the full content body is not required." }, "ArticleSimpleDataCustomerResponse": { "type": "object", "properties": { "url": { "type": "string", "description": "Url of the article", "nullable": true }, "exclude_from_external_search": { "type": "boolean", "description": "Indicates whether this article is excluded from external search engines. When true, the article will not be indexed by external search engines." }, "security_visibility": { "allOf": [ { "$ref": "#/components/schemas/SecurityVisibility" } ], "description": "The protection level of the article: 0 - Public (accessible to all), 1 - Protected (requires authentication), 2 - Mixed (inherits from project/version settings). This determines who can access the article.", "nullable": true }, "id": { "type": "string", "description": "The ID of the article", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "The article title", "nullable": true }, "public_version": { "type": "integer", "description": "The article version number(revision) that is currently published", "format": "int32", "readOnly": true }, "latest_version": { "type": "integer", "description": "The latest version number of this article", "format": "int32", "readOnly": true }, "language_code": { "type": "string", "description": "**Deprecated:** This property is deprecated and will be removed in a future version of the API. Please use /v2/Language/{projectVersionId} to fetch the languages in the project version\n\nThe default language code", "nullable": true, "deprecated": true }, "hidden": { "type": "boolean", "description": "Indicates if the article is visible on the site" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "order": { "type": "integer", "description": "The position of the article inside the parent category", "format": "int32" }, "slug": { "type": "string", "description": "The slug of the article", "nullable": true, "readOnly": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2", "nullable": true }, "translation_option": { "enum": [ "none", "needTranslation", "translated", "inProgress" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LanguageTranslationOption" } ], "description": "The translation status of the document.\r\nValid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress", "x-enumNames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-enum-varnames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-ms-enum": { "name": "LanguageTranslationOption", "modelAsString": true } }, "is_shared_article": { "type": "boolean", "description": "`True` indicates that the article is shared" }, "created_at": { "type": "string", "description": "Article created date time", "format": "date-time", "nullable": true, "readOnly": true }, "modified_at": { "type": "string", "description": "Article modified date time", "format": "date-time", "nullable": true, "readOnly": true }, "current_workflow_status_id": { "type": "string", "description": "Current Workflow status of the article", "nullable": true } }, "additionalProperties": false }, "ArticleSimpleVersionCustomer": { "type": "object", "properties": { "version_number": { "type": "integer", "description": "The version number of the article", "format": "int32" }, "created_by": { "type": "string", "description": "Author name", "nullable": true }, "created_at": { "type": "string", "description": "The date the article version was created", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The last time the article version was modified", "format": "date-time", "readOnly": true }, "base_version": { "type": "integer", "description": "The version number from which this article version is derived", "format": "int32" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "profile_url": { "type": "string", "description": "Author profile image", "nullable": true }, "comment": { "type": "string", "description": "Version comment (max 250 characters)", "nullable": true }, "version_type": { "type": "string", "description": "Derived version discriminator (version-less collab): draft, published, or system_backup. Null when collaborative editing is not enabled for the project.", "nullable": true }, "system_backup_ordinal": { "type": "integer", "description": "Presentation-only 1..M sequence over system-backup versions ordered by creation date. Null for published/draft versions and when collaborative editing is not enabled. Never an addressing key — use VersionNumber to fetch a specific version.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Compact version-history entry for an article — version number, author, timestamps, and publish state. Returned by `GET /v2/articles/{articleId}/{langCode}/versions`." }, "ArticleStaleStatus": { "enum": [ "fresh", "stale" ], "type": "string", "description": "The status of the article: 0 - None, 1 - New, 2 - Updated, 3 - Custom", "x-enumNames": [ "Fresh", "Stale" ], "x-enum-varnames": [ "Fresh", "Stale" ], "x-ms-enum": { "name": "ArticleStaleStatus", "modelAsString": true } }, "ArticleStatusCustomer": { "enum": [ "draft", "published" ], "type": "string", "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "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 } }, "ArticleUpdateWorkflowRequest": { "required": [ "article_ids", "lang_code", "project_version_id", "user_id", "workflow_status_info" ], "type": "object", "properties": { "project_version_id": { "minLength": 1, "type": "string", "description": "Identifier of the specific workspace in the project in which the articles exist. This ID is used to ensure the workflow status update is applied to articles in a particular workspace." }, "lang_code": { "minLength": 1, "type": "string", "description": "Language code of the articles whose workflow status is being updated (e.g., \"en\", \"fr\"). This ensures the workflow status update is applied to the article in the specified language." }, "user_id": { "minLength": 1, "type": "string", "description": "User ID of the team account changing the workflow status. This team account will be recorded in the audit log." }, "article_ids": { "type": "array", "items": { "type": "string" }, "description": "List of article IDs to be updated. Each ID in this array should refer to an existing article in the specified project version and language." }, "workflow_status_info": { "allOf": [ { "$ref": "#/components/schemas/ArticleWorkflowStatus" } ], "description": "Object for workflow status metadata. This object defines the new workflow status and any associated information like due date, comment, or assignee." } }, "additionalProperties": false }, "ArticleVersionDataCustomerResponse": { "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 }, "content": { "type": "string", "description": "If the article editor is **Markdown**, then the article content will be present in this property", "nullable": true }, "html_content": { "type": "string", "description": " If the article editor is **WYSIWYG (HTML)**, then the content will be present in this property. \r\n**Note**: Markdown editor will also have HTML content (read-only).", "nullable": true }, "category_id": { "type": "string", "description": "The ID of the article's parent category", "nullable": true }, "project_version_id": { "type": "string", "description": "The ID of the project version where the article is located", "nullable": true }, "version_number": { "type": "integer", "description": "The currently fetched version number of the article", "format": "int32" }, "public_version": { "type": "integer", "description": "The currently published version number of the article", "format": "int32", "readOnly": true }, "latest_version": { "type": "integer", "description": "The latest version number of the article", "format": "int32", "readOnly": true }, "enable_rtl": { "type": "boolean", "description": "`True` indicates that **Right to Left** alignment is enabled for the article language" }, "hidden": { "type": "boolean", "description": "`False` indicates that the article is visible on the site" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "version_type": { "type": "string", "description": "Derived version discriminator (version-less collab): draft, published, or system_backup. Null when collaborative editing is not enabled for the project. Display/system-backup ordinals are exposed only by the versions-list endpoint.", "nullable": true }, "order": { "type": "integer", "description": "The position inside the parent category", "format": "int32" }, "created_by": { "type": "string", "description": "The ID of the team account who created the article", "nullable": true }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/UserDetailsCustomer" }, "description": "The list of contributors in the article", "nullable": true }, "created_at": { "type": "string", "description": "The date on which the article was created", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The date on which the article was last modified", "format": "date-time", "readOnly": true }, "slug": { "type": "string", "description": "The slug of the article", "nullable": true, "readOnly": true }, "is_fall_back_content": { "type": "boolean", "description": "`True` indicates that the article content is a fallback of the default language content" }, "description": { "type": "string", "description": "The description of the article", "nullable": true }, "stale_status": { "allOf": [ { "$ref": "#/components/schemas/StaleStatus" } ], "description": "Fresh - Article is up-to-date\r\nStale - Article requires review", "nullable": true }, "category_type": { "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "0 - Folder, 1 - Page, 2 - Index", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG", "nullable": true }, "is_shared_article": { "type": "boolean", "description": "`True` indicates that the article is shared" }, "translation_option": { "enum": [ "none", "needTranslation", "translated", "inProgress" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LanguageTranslationOption" } ], "description": "The translation status of the document.\r\nValid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress", "x-enumNames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-enum-varnames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-ms-enum": { "name": "LanguageTranslationOption", "modelAsString": true } }, "url": { "type": "string", "description": "Url of the article", "nullable": true }, "current_workflow_status_id": { "type": "string", "description": "Current Workflow status of the article", "nullable": true }, "available_languages": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableLanguageInfo" }, "description": "Lists the languages in which the article is available, along with their translation status and URL.", "nullable": true }, "security_visibility": { "enum": [ "public", "private" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SecurityVisibility" } ], "description": "Indicates the visibility level of the article.\r\n0 - Public, 1 - Private", "x-enumNames": [ "Public", "Private" ], "x-enum-varnames": [ "Public", "Private" ], "x-ms-enum": { "name": "SecurityVisibility", "modelAsString": true } }, "custom_fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "Custom field values associated with the article. Returned for V1 callers only.", "nullable": true }, "custom_fields_data": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Custom field values as a compact key-value map. Returned for V2 callers only.\r\nKey is the field label. Value is in its native type: string, number, boolean, or a comma-separated string of labels for multi-select.", "nullable": true } }, "additionalProperties": false, "description": "Customer-facing payload for an article version returned by V2 endpoints (`GET /v2/articles/{articleId}/{langCode}` and friends). Includes content, settings, available translations, workflow state, security visibility, and any configured custom field values." }, "ArticleVersionInfoCustomerResponse": { "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 }, "content": { "type": "string", "description": "If the article editor is **Markdown**, then the article content will be present in this property", "nullable": true }, "html_content": { "type": "string", "description": " If the article editor is **WYSIWYG (HTML)**, then the content will be present in this property. \r\n**Note**: Markdown editor will also have HTML content (read-only).", "nullable": true }, "category_id": { "type": "string", "description": "The ID of the article's parent category", "nullable": true }, "project_version_id": { "type": "string", "description": "The ID of the project version where the article is located", "nullable": true }, "version_number": { "type": "integer", "description": "The currently fetched version number of the article", "format": "int32" }, "public_version": { "type": "integer", "description": "The currently published version number of the article", "format": "int32", "readOnly": true }, "latest_version": { "type": "integer", "description": "The latest version number of the article", "format": "int32", "readOnly": true }, "enable_rtl": { "type": "boolean", "description": "`True` indicates that **Right to Left** alignment is enabled for the article language" }, "hidden": { "type": "boolean", "description": "`False` indicates that the article is visible on the site" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "version_type": { "type": "string", "description": "Derived version discriminator (version-less collab): draft, published, or system_backup. Null when collaborative editing is not enabled for the project. Display/system-backup ordinals are exposed only by the versions-list endpoint.", "nullable": true }, "order": { "type": "integer", "description": "The position inside the parent category", "format": "int32" }, "created_by": { "type": "string", "description": "The ID of the team account who created the article", "nullable": true }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/UserDetailsCustomer" }, "description": "The list of contributors in the article", "nullable": true }, "created_at": { "type": "string", "description": "The date on which the article was created", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The date on which the article was last modified", "format": "date-time", "readOnly": true }, "slug": { "type": "string", "description": "The slug of the article", "nullable": true, "readOnly": true }, "is_fall_back_content": { "type": "boolean", "description": "`True` indicates that the article content is a fallback of the default language content" }, "description": { "type": "string", "description": "The description of the article", "nullable": true }, "stale_status": { "allOf": [ { "$ref": "#/components/schemas/StaleStatus" } ], "description": "Fresh - Article is up-to-date\r\nStale - Article requires review", "nullable": true }, "category_type": { "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "0 - Folder, 1 - Page, 2 - Index", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG", "nullable": true }, "is_shared_article": { "type": "boolean", "description": "`True` indicates that the article is shared" }, "translation_option": { "enum": [ "none", "needTranslation", "translated", "inProgress" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LanguageTranslationOption" } ], "description": "The Translation status of the article", "x-enumNames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-enum-varnames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-ms-enum": { "name": "LanguageTranslationOption", "modelAsString": true } }, "version_created_at": { "type": "string", "description": "Latest version created date", "format": "date-time" }, "custom_fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "Custom field values associated with the article. Returned for V1 callers only.", "nullable": true }, "custom_fields_data": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Custom field values as a compact key-value map. Returned for V2 callers only.\r\nKey is the field label. Value is in its native type: string, number, boolean, or a comma-separated string of labels for multi-select.", "nullable": true } }, "additionalProperties": false }, "ArticleWorkflowStatus": { "type": "object", "properties": { "status_id": { "type": "string", "description": "ID of the workflow status to apply to the listed articles. If omitted, no status change is applied. The value should match one of the predefined workflow statuses in the project.", "nullable": true }, "due_date": { "type": "string", "description": "Due date associated with the workflow status for completing the task or review. It should be in ISO 8601 format (yyyy-mm-ddThh:mm:ss)", "format": "date-time", "nullable": true }, "comment": { "type": "string", "description": "Optional text comment added along with the workflow status update. Useful for provided high-level instructions, context, or decisions.", "nullable": true }, "assignee_id": { "type": "string", "description": "ID of the user assigned to this workflow status. Assigning someone to a workflow status ensures they are notified via email.", "nullable": true } }, "additionalProperties": false }, "AvailableLanguageInfo": { "type": "object", "properties": { "lang_code": { "type": "string", "description": "The language code of the translated document.", "nullable": true }, "url": { "type": "string", "description": "The URL of the translated document.", "nullable": true }, "translation_status": { "enum": [ "none", "needTranslation", "translated", "inProgress" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/LanguageTranslationOption" } ], "description": "The translation status of the document.\r\nValid values: 0 - None, 1 - Need Translation, 2 - Translated, 3 - In Progress", "x-enumNames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-enum-varnames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-ms-enum": { "name": "LanguageTranslationOption", "modelAsString": true } } }, "additionalProperties": false, "description": "Represents information about an available language translation for an article or category." }, "BackgroundTaskStatus": { "enum": [ "queued", "initiated", "inProgress", "completed", "error", "cancelled", "waitingForCallback", "partiallyCompleted" ], "type": "string", "description": "0 - Queued, 1 - Initiated, 2 - InProgress, 3 - Completed, 4 - Error, 5 - Cancelled", "x-enumNames": [ "Queued", "Initiated", "InProgress", "Completed", "Error", "Cancelled", "WaitingForCallback", "PartiallyCompleted" ], "x-enum-varnames": [ "Queued", "Initiated", "InProgress", "Completed", "Error", "Cancelled", "WaitingForCallback", "PartiallyCompleted" ], "x-ms-enum": { "name": "BackgroundTaskStatus", "modelAsString": true } }, "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." }, "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." }, "BaseResponse": { "type": "object", "properties": { "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "Round-trip extension data for forward-compat fields not modelled here.", "nullable": true }, "context": { "allOf": [ { "$ref": "#/components/schemas/BaseResponseContext" } ], "description": "Optional response-level context (e.g. caller reference for log correlation).", "nullable": true }, "success": { "type": "boolean", "description": "True when the request succeeded. Always inspect this before consuming the success-shape fields.", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BaseError" }, "description": "List of structured errors. Populated when Document360.Core.Messages.Core.BaseResponse.success is false.", "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BaseWarning" }, "description": "List of non-fatal warnings — the request succeeded, but with caveats worth surfacing to the user.", "nullable": true }, "information": { "type": "array", "items": { "$ref": "#/components/schemas/BaseInformation" }, "description": "Informational messages — context the SPA might use (e.g. fallback logic, skipped operations).", "nullable": true }, "feature_explorer_status": { "allOf": [ { "$ref": "#/components/schemas/FeatureExplorerStatus" } ], "description": "Onboarding/feature-explorer status payload, surfaced via response interceptors.", "nullable": true }, "custom_page_element": { "allOf": [ { "$ref": "#/components/schemas/UIElement" } ], "description": "UI element directive returned alongside the response when the SPA should render an inline tip or banner.", "nullable": true } }, "additionalProperties": false, "description": "Canonical Portal API response envelope. Every endpoint's response either is a\r\nDocument360.Core.Messages.Core.BaseResponse or derives from one. Carries the success flag plus\r\narrays of structured errors, warnings, and informational messages — the whole\r\nof which the SPA inspects to render success/error UI." }, "BaseResponseContext": { "type": "object", "properties": { "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "Round-trip extension data for forward-compat fields.", "nullable": true }, "caller_reference": { "type": "string", "description": "Optional opaque ID supplied by the caller, echoed back in audit logs and responses.", "nullable": true } }, "additionalProperties": false, "description": "Context attached to a response — currently identical to Document360.Core.Messages.Core.BaseContext but kept distinct so request and response contexts can evolve independently." }, "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." }, "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." }, "BulkArticleResultCustomer": { "type": "object", "properties": { "index": { "type": "integer", "description": "The zero-based position of this item in the original request array.", "format": "int32" }, "article_id": { "type": "string", "description": "Article ID that has updated", "nullable": true }, "lang_code": { "type": "string", "description": "Language code of the article translation that was updated.", "nullable": true }, "success": { "type": "boolean", "description": "Indicates if articles creation was successful", "readOnly": true }, "details": { "type": "string", "description": "Additional information about articles creation status", "nullable": true } }, "additionalProperties": false }, "BulkCategoryResult": { "type": "object", "properties": { "index": { "type": "integer", "description": "The zero-based position of this item in the original request array.", "format": "int32" }, "category_id": { "type": "string", "description": "The ID of the category", "nullable": true }, "lang_code": { "type": "string", "description": "Language code of the category translation that was updated.", "nullable": true }, "success": { "type": "boolean", "description": "`True` - Category is published\r\n`False` - Category is not published", "readOnly": true }, "details": { "type": "string", "description": "Description of the action performed", "nullable": true } }, "additionalProperties": false }, "BulkCreateArticleResponseCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkArticleResultCustomer" }, "description": "Bulk article create response", "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 }, "BulkCreateCategoryResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkCategoryResult" }, "description": "bulk category response 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 }, "BulkDeleteArticleResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkArticleResultCustomer" }, "description": "Bulk delete article response", "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 }, "BulkDeleteArticleVersionResonse": { "type": "object", "properties": { "article_id": { "type": "string", "description": "IDs of the articles", "nullable": true }, "data": { "type": "string", "description": "Response article 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 }, "BulkDeleteCategoryVersionResponse": { "type": "object", "properties": { "category_id": { "type": "string", "description": "The ID of the category", "nullable": true }, "data": { "type": "string", "description": "The list of deleted category versions", "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 }, "BulkPublishArticle": { "required": [ "article_id", "user_id", "version_number" ], "type": "object", "properties": { "article_id": { "minLength": 1, "type": "string", "description": "The ID of the article" }, "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account that will be marked as the contributor of this publish" }, "version_number": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The version number of the article to be published", "format": "int32" }, "publish_message": { "type": "string", "description": "The publish message of the article", "nullable": true } }, "additionalProperties": false }, "BulkPublishCategory": { "required": [ "category_id", "user_id", "version_number" ], "type": "object", "properties": { "category_id": { "minLength": 1, "type": "string", "description": "The ID of the category" }, "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account responsible for the publish" }, "version_number": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "Version number of the category page", "format": "int32" }, "publish_message": { "type": "string", "description": "Publish message for the category", "nullable": true } }, "additionalProperties": false }, "BulkPublishCategoryResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkCategoryResult" }, "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 }, "BulkUnpublishArticle": { "required": [ "article_id", "version_number" ], "type": "object", "properties": { "article_id": { "minLength": 1, "type": "string", "description": "The ID of the article" }, "version_number": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The version number of the article to be unpublished", "format": "int32" } }, "additionalProperties": false }, "BulkUnpublishArticleRequest": { "required": [ "articles", "project_version_id", "user_id" ], "type": "object", "properties": { "articles": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUnpublishArticle" }, "description": "Details of the articles need to be unpublished" }, "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account that will be marked as the contributor of this unpublish" }, "project_version_id": { "minLength": 1, "type": "string", "description": "The project version ID where the article exists." }, "unpublish_message": { "type": "string", "description": "The unpublish message of the article", "nullable": true } }, "additionalProperties": false }, "BulkUnpublishArticleResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkArticleResultCustomer" }, "description": "Bulk unpublish article response 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 }, "BulkUnpublishCategory": { "required": [ "category_id", "version_number" ], "type": "object", "properties": { "category_id": { "minLength": 1, "type": "string", "description": "The ID of the category" }, "version_number": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The version number of the category to be unpublished", "format": "int32" } }, "additionalProperties": false }, "BulkUnpublishCategoryRequest": { "required": [ "categories", "project_version_id", "user_id" ], "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUnpublishCategory" }, "description": "Details of the categories need to be unpublished" }, "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account that will be marked as the contributor of this unpublish" }, "project_version_id": { "minLength": 1, "type": "string", "description": "The project version ID where the category exists." }, "unpublish_message": { "type": "string", "description": "The unpublish message of the category", "nullable": true } }, "additionalProperties": false }, "BulkUnpublishCategoryResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkCategoryResult" }, "description": "Bulk unpublish article response 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 }, "BulkUpdateArticle": { "type": "object", "properties": { "article_id": { "type": "string", "description": "The ID of the article", "nullable": true }, "lang_code": { "type": "string", "description": "Language code of the article", "nullable": true }, "title": { "type": "string", "description": "The title of the article", "nullable": true }, "content": { "type": "string", "description": "The content of the article, for any Editor type, use this property.", "nullable": true }, "html_content": { "type": "string", "description": "The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use **content** property instead of this.)", "nullable": true, "deprecated": true }, "category_id": { "type": "string", "description": "The ID of the category. If the article has to be moved to another category, enter the desired category ID", "nullable": true }, "hidden": { "type": "boolean", "description": "Visibility status of the article. **true** - Article will be hidden; **false** - Article will be shown" }, "version_number": { "type": "integer", "description": "The version number of the article to be updated. The latest version is updated by default.", "format": "int32", "nullable": true }, "translation_option": { "type": "string", "description": "Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated", "nullable": true }, "source": { "type": "string", "description": "Free text used for future reference", "nullable": true }, "order": { "type": "integer", "description": "To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).", "format": "int32" }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The format of `content`, for articles written in Editor 3.0 (which are always stored as Advanced\r\nWYSIWYG): 2 (Block, the default when omitted) - `content` is the article HTML; 0 (Markdown) -\r\n`content` is DFM markdown, the format GET returns in `content`, so a GET-then-update round\r\ntrip sends it back with 0. 1 (WYSIWYG) is rejected. Ignored for every other article, which keeps its\r\nstored format.", "nullable": true } }, "additionalProperties": false }, "BulkUpdateArticleResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkArticleResultCustomer" }, "description": "Bulk updated article 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 }, "BulkUpdateCategoryContentResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkCategoryResult" }, "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, "description": "Bulk Updating of category content" }, "CategoryAccessInfo": { "type": "object", "properties": { "category_name": { "type": "string", "nullable": true }, "category_id": { "type": "string", "nullable": true }, "language_id": { "type": "string", "nullable": true }, "language_name": { "type": "string", "nullable": true }, "language_code": { "type": "string", "nullable": true }, "version_name": { "type": "string", "nullable": true }, "version_id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CategoryDataBySlugCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the document.", "nullable": true, "readOnly": true }, "name": { "type": "string", "description": "The Name of the document.", "nullable": true }, "description": { "type": "string", "description": "A short description or summary of the document.", "nullable": true }, "project_version_id": { "type": "string", "description": "The ID of the project version where the document is located.", "nullable": true }, "order": { "type": "integer", "description": "The position the category inside the parent category", "format": "int32" }, "parent_category_id": { "type": "string", "description": "The ID of the parent category containing this document. Returns null for top-level categories.", "nullable": true }, "hidden": { "type": "boolean", "description": "Indicates if the category is visible on the site ( If \"false,\" all the child categories and articles will be hidden as well )" }, "slug": { "type": "string", "description": "The slug (URL-friendly identifier) of the document.", "nullable": true, "readOnly": true }, "content": { "type": "string", "description": "The document content in Markdown format. Populated when the editor type is Markdown.", "nullable": true }, "enable_rtl": { "type": "boolean", "description": "Returns true if right-to-left text alignment is enabled for the selected language for the document." }, "html_content": { "type": "string", "description": "The document content in HTML format. Populated when the editor type is WYSIWYG (HTML). For Markdown editors, this field is read-only.", "nullable": true }, "version_number": { "type": "integer", "description": "The version number of the document currently fetched.", "format": "int32" }, "category_type": { "enum": [ "default", "customContent", "linksToArticle" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "The editor type used for the document.\r\nValid values: 0 - Markdown, 1 - WYSIWYG(HTML), 2 - Advanced WYSIWYG", "x-enumNames": [ "Default", "CustomContent", "LinksToArticle" ], "x-enum-varnames": [ "Default", "CustomContent", "LinksToArticle" ], "x-ms-enum": { "name": "CategoryType", "modelAsString": true } }, "created_at": { "type": "string", "description": "The date and time when the document was created.", "format": "date-time", "nullable": true, "readOnly": true }, "modified_at": { "type": "string", "description": "The date and time when the document was last modified.", "format": "date-time", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the page type category: 0 - Draft, 3 - Published", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The editor type used for the document.\r\nValid values: 0 - Markdown, 1 - WYSIWYG(HTML), 2 - Advanced WYSIWYG", "nullable": true }, "current_workflow_status_id": { "type": "string", "description": "The current workflow status ID of the document.", "nullable": true }, "stale_status": { "allOf": [ { "$ref": "#/components/schemas/StaleStatus" } ], "description": "Fresh - Category page is up-to-date\r\nStale - Category page requires review", "nullable": true }, "lang_code": { "type": "string", "description": "The language code of the category", "nullable": true }, "available_languages": { "type": "array", "items": { "$ref": "#/components/schemas/AvailableLanguageInfo" }, "description": "Lists the languages the article or category is available in, along with their translation status and slug", "nullable": true }, "settings": { "allOf": [ { "$ref": "#/components/schemas/DocumentSettings" } ], "description": "Contains SEO settings and exclusion preferences for the document.", "nullable": true }, "security_visibility": { "allOf": [ { "$ref": "#/components/schemas/SecurityVisibility" } ], "description": "Indicates the visibility level of the article.Valid values are: \r\n0 - Public(accessible to all readers)\r\n1 - Private(accessible only to authenticated users or specific teams).", "nullable": true }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/ContributorInfoCustomer" }, "nullable": true }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleSimpleDataCustomer" }, "description": "The list of articles attached to this category", "nullable": true }, "child_categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDataCustomer" }, "description": "The list of categories attached to this category", "nullable": true }, "custom_fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "Custom field values associated with the category. Returned for V1 callers only.", "nullable": true }, "custom_fields_data": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Custom field values as a compact key-value map. Returned for V2 callers only.\r\nKey is the field label. Value is in its native type: string, number, boolean, or a comma-separated string of labels for multi-select.", "nullable": true } }, "additionalProperties": false, "description": "Customer-facing payload for a category resolved by slug — includes the category body, available languages, settings, child categories, and articles within it." }, "CategoryDataCustomer": { "type": "object", "properties": { "articles": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleSimpleDataCustomer" }, "description": "The list of articles attached to this category", "nullable": true }, "child_categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDataCustomer" }, "description": "The list of categories attached to this category", "nullable": true }, "id": { "type": "string", "description": "The ID of the category", "nullable": true, "readOnly": true }, "name": { "type": "string", "description": "Name of the category", "nullable": true }, "description": { "type": "string", "description": "Description of the category", "nullable": true }, "project_version_id": { "type": "string", "description": "The ID of the project version where this category is located", "nullable": true }, "order": { "type": "integer", "description": "The position the category inside the parent category", "format": "int32" }, "parent_category_id": { "type": "string", "description": "The ID of the parent category ( null if top-level )", "nullable": true }, "hidden": { "type": "boolean", "description": "Indicates if the category is visible on the site ( If \"false,\" all the child categories and articles will be hidden as well )" }, "icon": { "type": "string", "description": "Unicode representation of the icon or image URL", "nullable": true }, "slug": { "type": "string", "description": "The slug of the category", "nullable": true, "readOnly": true }, "language_code": { "type": "string", "description": "Language code of the category", "nullable": true }, "category_type": { "enum": [ "default", "customContent", "linksToArticle" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "0 - Folder, 1 - Page, 2 - Index", "x-enumNames": [ "Default", "CustomContent", "LinksToArticle" ], "x-enum-varnames": [ "Default", "CustomContent", "LinksToArticle" ], "x-ms-enum": { "name": "CategoryType", "modelAsString": true } }, "created_at": { "type": "string", "description": "Category created date time", "format": "date-time", "nullable": true, "readOnly": true }, "modified_at": { "type": "string", "description": "Category modified date time", "format": "date-time", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the page type category: 0 - Draft, 3 - Published", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The content type of the page type category: Markdown = 0, Wysiwyg = 1, Block = 2", "nullable": true }, "current_workflow_status_id": { "type": "string", "description": "Current Workflow status of the article", "nullable": true } }, "additionalProperties": false, "description": "Full category payload — extends Document360.Core.Models.Public.Categories.CategoryDataBaseCustomer with the articles and child categories that live inside this category. Forms the recursive tree returned by `GET /v2/projectversions/{projectVersionId}/categories`." }, "CategoryMeta": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the category", "nullable": true, "readOnly": true, "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "language_id": { "type": "string", "description": "The language ID for the category content. Specifies which language version of the category to export.", "nullable": true, "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "version_id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "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 }, "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`." }, "CategorySimpleData": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the category", "nullable": true, "readOnly": true }, "name": { "type": "string", "description": "Name of the category", "nullable": true }, "order": { "type": "integer", "description": "The position inside the parent category", "format": "int32" }, "icon": { "type": "string", "description": "Unicode representation of the icon", "nullable": true } }, "additionalProperties": false, "description": "Minimal category descriptor — just identity, name, position, and icon. Returned by category create/update endpoints where echoing back the full payload is unnecessary." }, "CategorySimpleVersionCustomer": { "type": "object", "properties": { "version_number": { "type": "integer", "description": "The currently fetched version number of this category page", "format": "int32" }, "created_by": { "type": "string", "description": "The ID of the user that created the category page", "nullable": true }, "created_at": { "type": "string", "description": "The date the category page was created", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The date the category page was last modified", "format": "date-time", "readOnly": true }, "base_version": { "type": "integer", "description": "The base version of the currently fetched category page", "format": "int32" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "profile_url": { "type": "string", "description": "The URL of team account's profile image", "nullable": true }, "version_type": { "type": "string", "description": "Derived version discriminator (version-less collab): draft, published, or system_backup. Null when collaborative editing is not enabled for the project.", "nullable": true }, "system_backup_ordinal": { "type": "integer", "description": "Presentation-only 1..M sequence over system-backup versions ordered by creation date. Null for published/draft versions and when collaborative editing is not enabled. Never an addressing key — use VersionNumber to fetch a specific version.", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CategorySummaryCustomerV2": { "type": "object", "properties": { "category_id": { "type": "string", "description": "The category ID to which the user should be given access.", "nullable": true }, "project_version_id": { "type": "string", "description": "The project version ID to which the category belongs.", "nullable": true }, "language_code": { "type": "string", "description": "The language to which the user should be given access.", "nullable": true } }, "additionalProperties": false, "description": "Category-scoped access entry — identifies a (category, workspace, language) tuple. Used inside V2 reader and reader-group access scopes." }, "CategoryType": { "enum": [ "default", "customContent", "linksToArticle" ], "type": "string", "description": "Defines what a category represents in the documentation hierarchy.", "x-enumNames": [ "Default", "CustomContent", "LinksToArticle" ], "x-enum-varnames": [ "Default", "CustomContent", "LinksToArticle" ], "x-ms-enum": { "name": "CategoryType", "modelAsString": true } }, "CategoryVersionData": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the category", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "Category title", "nullable": true }, "content": { "type": "string", "description": "Category page Markdown content", "nullable": true }, "html_content": { "type": "string", "description": "Category page WYSIWYG(HTML) content", "nullable": true }, "block_content": { "type": "string", "description": "Category page Advanced WYSIWYG content", "nullable": true }, "parent_category_id": { "type": "string", "description": "Parent category ID", "nullable": true }, "project_document_version_id": { "type": "string", "description": "Project document version ID", "nullable": true }, "version_number": { "type": "integer", "description": "The currently fetched version number of this category page", "format": "int32" }, "public_version": { "type": "integer", "description": "The version number that is currently published", "format": "int32", "readOnly": true }, "latest_version": { "type": "integer", "description": "The latest version number(revision) of this category page.", "format": "int32", "readOnly": true }, "enable_rtl": { "type": "boolean", "description": "Indicates if Right to Left alignment is enabled for the category page language" }, "hidden": { "type": "boolean", "description": "Indicates if the category page is visible on the site" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the article: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "version_type": { "type": "string", "description": "Derived version discriminator (version-less collab): draft, published, or system_backup. Null when collaborative editing is not enabled for the project. Display/system-backup ordinals are exposed only by the versions-list endpoint.", "nullable": true }, "created_by": { "type": "string", "description": "The ID of the user that created the category page", "nullable": true }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/UserProfileCustomer" }, "description": "The list of authors that contributed to this category page", "nullable": true }, "created_at": { "type": "string", "description": "The date the category page was created", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The date the category page was last modified", "format": "date-time", "readOnly": true }, "slug": { "type": "string", "description": "The slug of the category page", "nullable": true, "readOnly": true }, "is_fall_back_content": { "type": "boolean", "description": "Indicates whether the category page content is a fallback of the default language content or not" }, "stale_status": { "allOf": [ { "$ref": "#/components/schemas/StaleStatus" } ], "description": "Fresh - Category page is up-to-date\r\nStale - Category page requires review", "nullable": true }, "content_type": { "type": "string", "description": "0 - Markdown\r\n1 - WYSIWYG(HTML)\r\n2 - Advanced WYSIWYG", "nullable": true }, "current_workflow_status_id": { "type": "string", "description": "Current Workflow status of the article", "nullable": true }, "is_block_editor": { "type": "boolean", "readOnly": true }, "custom_fields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "Custom field values associated with the category. Returned for V1 callers only.", "nullable": true }, "custom_fields_data": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Custom field values as a compact key-value map. Returned for V2 callers only.\r\nKey is the field label. Value is in its native type: string, number, boolean, or a comma-separated string of labels for multi-select.", "nullable": true } }, "additionalProperties": false }, "CategoryVersionDataCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the category", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "The title of the category", "nullable": true }, "content": { "type": "string", "description": "The content of the category", "nullable": true }, "html_content": { "type": "string", "description": "The HTML content of the category", "nullable": true }, "block_content": { "type": "string", "description": "The HTML content of the category (Block editor)", "nullable": true }, "category_id": { "type": "string", "description": "Existing category ID", "nullable": true }, "project_version_id": { "type": "string", "description": "Existing project version ID", "nullable": true }, "version_number": { "type": "integer", "description": "Category Version Number", "format": "int32" }, "public_version": { "type": "integer", "description": "The ID of the project version where this category is located", "format": "int32", "readOnly": true }, "latest_version": { "type": "integer", "description": "The latest version number of this category", "format": "int32", "readOnly": true }, "enable_rtl": { "type": "boolean", "description": "Indicates if Right to Left alignment is enabled for the category language" }, "hidden": { "type": "boolean", "description": "Indicates if the category is visible on the site" }, "status": { "enum": [ "draft", "published" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the category: 0 - Draft, 3 - Published", "x-enumNames": [ "Draft", "Published" ], "x-enum-varnames": [ "Draft", "Published" ], "x-ms-enum": { "name": "ArticleStatusCustomer", "modelAsString": true } }, "version_type": { "type": "string", "description": "Derived version discriminator (version-less collab): draft, published, or system_backup. Null when collaborative editing is not enabled for the project. Display/system-backup ordinals are exposed only by the versions-list endpoint.", "nullable": true }, "order": { "type": "integer", "description": "The position inside the parent category", "format": "int32" }, "created_by": { "type": "string", "description": "The ID of the user that created the category", "nullable": true }, "authors": { "type": "array", "items": { "$ref": "#/components/schemas/UserProfileCustomer" }, "description": "The list of authors that contributed to this category", "nullable": true }, "created_at": { "type": "string", "description": "The date the category was created", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The date the category was last modified", "format": "date-time", "readOnly": true }, "slug": { "type": "string", "description": "The slug of the category", "nullable": true, "readOnly": true }, "is_fall_back_content": { "type": "boolean", "description": "Indicates whether the category content is a fallback of the default language content or not" } }, "additionalProperties": false }, "CategoryWorkflowStatus": { "type": "object", "properties": { "status_id": { "type": "string", "description": "ID of the workflow status to apply to the listed articles. If omitted, no status change is applied. The value should match one of the predefined workflow statuses in the project.", "nullable": true }, "due_date": { "type": "string", "description": "Due date associated with the workflow status for completing the task or review. It should be in ISO 8601 format (yyyy-mm-ddThh:mm:ss)", "format": "date-time", "nullable": true }, "comment": { "type": "string", "description": "Optional text comment added along with the workflow status update. Useful for provided high-level instructions, context, or decisions.", "nullable": true }, "assignee_id": { "type": "string", "description": "ID of the user assigned to this workflow status. Assigning someone to a workflow status ensures they are notified via email.", "nullable": true } }, "additionalProperties": false }, "CompleteUserInfoCustomer": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The ID of the user", "nullable": true }, "first_name": { "type": "string", "description": "First name of the user", "nullable": true }, "last_name": { "type": "string", "description": "Last name of the user", "nullable": true }, "email_id": { "type": "string", "description": "Email address of the user", "nullable": true }, "profile_logo_url": { "type": "string", "description": "Profile image URL of the user", "nullable": true }, "last_login_at": { "type": "string", "description": "Last login date of the user", "format": "date-time", "nullable": true, "readOnly": true }, "portal_role": { "allOf": [ { "$ref": "#/components/schemas/RoleSummaryCustomer" } ], "description": "The name of the portal role", "nullable": true }, "content_roles": { "type": "array", "items": { "$ref": "#/components/schemas/ContentRoleSummaryCustomer" }, "description": "The name of content role", "nullable": true }, "associated_groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInfo" }, "description": "THe group associated with the team account", "nullable": true } }, "additionalProperties": false }, "CompleteUserInfoCustomerCustomerApiResponse": { "type": "object", "properties": { "result": { "allOf": [ { "$ref": "#/components/schemas/CompleteUserInfoCustomer" } ], "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `true`.", "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, "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." }, "Content": { "type": "object", "properties": { "value": { "type": "string", "description": "Markup text with occurrences highlighted.", "nullable": true }, "match_level": { "type": "string", "description": "Indicates how well the attribute matched the search query. Can be: none, partial, full", "nullable": true } }, "additionalProperties": false }, "ContentPermissionCustomer": { "required": [ "access_scope", "associated_content_role_id" ], "type": "object", "properties": { "associated_content_role_id": { "minLength": 1, "type": "string", "description": "The content role id of the team account.Please refer GET **/Teams/roles** endpoint to get the list of content roles." }, "access_scope": { "allOf": [ { "$ref": "#/components/schemas/AddUpdateAccessScopeCustomerV2" } ], "description": "The access level of the team account. With the access level, you will be able to set the permissions at a granular level. For example, you can limit the user to view articles only for a particular language/category/version." } }, "additionalProperties": false, "description": "The content permission of the team account" }, "ContentRoleInfo": { "type": "object", "properties": { "version_access_info": { "allOf": [ { "$ref": "#/components/schemas/VersionAccessInfo" } ], "nullable": true }, "language_access_info": { "allOf": [ { "$ref": "#/components/schemas/LanguageAccessInfo" } ], "nullable": true }, "category_access_info": { "allOf": [ { "$ref": "#/components/schemas/CategoryAccessInfo" } ], "nullable": true }, "article_access_info": { "allOf": [ { "$ref": "#/components/schemas/ArticleAccessInfo" } ], "nullable": true }, "access_scope_level": { "enum": [ "none", "category", "version", "project", "language", "article", "workspace", "guides", "guideCategories", "knowledgeBaseDisabled" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccessScopeLevel" } ], "description": "This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage, 5 - Article, 6 - Workspace, 7 - Guides, 8 - GuideCategories, 9 - KnowledgeBaseDisabled", "x-enumNames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "x-enum-varnames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "x-ms-enum": { "name": "AccessScopeLevel", "modelAsString": true } }, "guide_access_info": { "allOf": [ { "$ref": "#/components/schemas/GuideAccessInfo" } ], "nullable": true }, "guide_category_access_info": { "allOf": [ { "$ref": "#/components/schemas/CategoryAccessInfo" } ], "nullable": true }, "role_name": { "type": "string", "nullable": true }, "role_id": { "type": "string", "nullable": true }, "group_name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContentRoleSummaryCustomer": { "type": "object", "properties": { "version_access": { "allOf": [ { "$ref": "#/components/schemas/VersionAccessInfo" } ], "nullable": true }, "language_access": { "allOf": [ { "$ref": "#/components/schemas/LanguageAccessInfo" } ], "nullable": true }, "category_access": { "allOf": [ { "$ref": "#/components/schemas/CategoryAccessInfo" } ], "nullable": true }, "article_access": { "allOf": [ { "$ref": "#/components/schemas/ArticleAccessInfo" } ], "nullable": true }, "access_scope_level": { "enum": [ "none", "category", "version", "project", "language", "article", "workspace", "guides", "guideCategories", "knowledgeBaseDisabled" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/AccessScopeLevel" } ], "description": "This is an enum. Possible values are 0 - None, 1 - Category, 2 - Version, 3 - Project, 4 - Lanaguage, 5 - Article, 6 - Workspace, 7 - Guides, 8 - GuideCategories, 9 - KnowledgeBaseDisabled", "x-enumNames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "x-enum-varnames": [ "None", "Category", "Version", "Project", "Language", "Article", "Workspace", "Guides", "GuideCategories", "KnowledgeBaseDisabled" ], "x-ms-enum": { "name": "AccessScopeLevel", "modelAsString": true } }, "role_id": { "type": "string", "nullable": true }, "role_name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContributorInfoCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the contributor.", "nullable": true, "readOnly": true }, "first_name": { "type": "string", "description": "The contributor's first name.", "nullable": true }, "last_name": { "type": "string", "description": "The contributor's last name.", "nullable": true }, "email_id": { "type": "string", "description": "The email address of the contributor.", "nullable": true }, "profile_logo_url": { "type": "string", "description": "The profile logo URL of the contributor.", "nullable": true } }, "additionalProperties": false, "description": "Compact contributor info — identity and profile picture only. Returned as part of article/category author lists." }, "CreateArticleRequest": { "required": [ "project_version_id", "title", "user_id" ], "type": "object", "properties": { "title": { "minLength": 1, "type": "string", "description": "The title of the article" }, "content": { "type": "string", "description": "The content of the article, for any Editor type, use this property", "nullable": true }, "category_id": { "type": "string", "description": "The ID of the category where the article will be created, CategoryId will be null for custom pages", "nullable": true }, "project_version_id": { "minLength": 1, "type": "string", "description": "The project version ID in which the article will be created" }, "order": { "type": "integer", "description": "The position of the article in the category tree (By default, it will be placed at the bottom of the category)", "format": "int32" }, "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account that will be marked as a contributor of the article" }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG", "default": null, "nullable": true }, "slug": { "type": "string", "description": "Optional custom URL-friendly slug for the article. If not provided, a slug will be auto-generated from the title.\r\nWhen provided, the slug must be unique within the project version, otherwise an error will be returned.", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "CreateArticleResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ArticleSimpleDataCustomer" } ], "description": "Create article response 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 }, "CustomFieldDefinitionResponse": { "type": "object", "properties": { "field_id": { "type": "string", "description": "The unique identifier for the custom field definition (use this when updating values)", "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 } }, "placeholder": { "type": "string", "description": "Placeholder text for the field", "nullable": true }, "help_text": { "type": "string", "description": "Help text describing the field", "nullable": true }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOptionResponse" }, "description": "Available options for Dropdown and MultiSelectDropdown fields", "nullable": true }, "max_length": { "type": "integer", "description": "Maximum length for text fields", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Response model for custom field definition metadata" }, "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" }, "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 } }, "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 (array of option IDs)", "nullable": true } }, "additionalProperties": false, "description": "Request model for updating a custom field value" }, "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 (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" }, "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 }, "DataSourceType": { "enum": [ "internalKBArticle", "externalSource" ], "type": "string", "description": "Possible values: `\"internalKBArticle\"` = InternalKBArticle, `\"externalSource\"` = ExternalSource", "x-enumNames": [ "InternalKBArticle", "ExternalSource" ], "x-enum-varnames": [ "InternalKBArticle", "ExternalSource" ], "x-ms-enum": { "name": "DataSourceType", "modelAsString": true } }, "DateRange": { "type": "object", "properties": { "after": { "type": "string", "description": "Filter the articles which are all modified after the given date", "format": "date-time", "nullable": true }, "before": { "type": "string", "description": "Filter the articles which are all modified before the given date", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DeleteApiDefinitionCustomer": { "type": "object", "properties": { "api_reference_id": { "type": "string", "description": "The ID of the API reference", "nullable": true }, "details": { "type": "string", "description": "Status message", "nullable": true } }, "additionalProperties": false, "description": "Deletion outcome for one API reference." }, "DeleteApiReferenceResponseCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeleteApiDefinitionCustomer" }, "description": "Per-API-reference deletion result.", "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, "description": "Response wrapper for `DELETE /v2/apireferences` — reports the status of the requested API reference deletion(s)." }, "DeleteMediaFileResponseCustomer": { "type": "object", "properties": { "task_id": { "type": "string", "description": "The task ID for the asynchronous delete operation. Poll for status with `GET /v2/drive/Folders/DeleteFile/Status/{taskId}`.", "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, "description": "Response from `DELETE /v2/drive/Folders/{folderId}/{fileId}`. Deletion is asynchronous — poll `GET /v2/drive/Folders/DeleteFile/Status/{taskId}` with the returned task ID to track completion." }, "DeletedEndpointInfoCustomer": { "type": "object", "properties": { "method": { "type": "string", "description": "HTTP method, e.g. GET, POST.", "nullable": true }, "path": { "type": "string", "description": "Endpoint path, e.g. /users/{id}.", "nullable": true }, "article_id": { "type": "string", "description": "Article ID associated with this endpoint.", "nullable": true }, "title": { "type": "string", "description": "Title of the article that documents this endpoint.", "nullable": true } }, "additionalProperties": false, "description": "One endpoint article that a resync would remove. Returned during dry-run (when `ForceImport = false`) so callers can confirm before committing." }, "DeletedandStarredMetaDataCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The file ID", "nullable": true, "readOnly": true }, "file_name": { "type": "string", "description": "The file name", "nullable": true }, "file_type": { "type": "string", "description": "The file type", "nullable": true }, "file_url": { "type": "string", "description": "The file URL", "nullable": true }, "updated_on": { "type": "string", "description": "The date the file was uploaded", "format": "date-time", "readOnly": true }, "updated_by": { "type": "string", "description": "The ID of user who uploaded the file", "nullable": true }, "size": { "type": "string", "description": "The file size", "nullable": true }, "height": { "type": "string", "description": "The file height", "nullable": true }, "width": { "type": "string", "description": "The file width", "nullable": true }, "title": { "type": "string", "description": "The file title", "nullable": true }, "alternative_text": { "type": "string", "description": "The alternative text", "nullable": true }, "is_starred": { "type": "boolean", "description": "This denotes the file is starred or not" }, "parent_folder_id": { "type": "string", "description": "The parent folder ID", "nullable": true }, "tag_ids": { "type": "array", "items": { "type": "string" }, "description": "The tagIds associated with the file", "nullable": true } }, "additionalProperties": false }, "DocumentCustomer": { "type": "object", "properties": { "document_type": { "enum": [ "article", "category" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DocumentTypeCustomer" } ], "description": "Indicates whether the retrieved document is an article or a category.\r\nValid values: 0 - Article, 1 - Category", "x-enumNames": [ "Article", "Category" ], "x-enum-varnames": [ "Article", "Category" ], "x-ms-enum": { "name": "DocumentTypeCustomer", "modelAsString": true } }, "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryDataBySlugCustomer" } ], "description": "Contains information about the category if the DocumentType is a Category.", "nullable": true }, "article": { "allOf": [ { "$ref": "#/components/schemas/ArticleDataBySlugCustomer" } ], "description": "Contains information about the category if the DocumentType is a Article.", "nullable": true } }, "additionalProperties": false, "description": "Unified document payload returned by `GET /v2/project/Document`. The shape depends on Document360.Core.Models.Public.DocumentCustomer.DocumentType: an article populates Document360.Core.Models.Public.DocumentCustomer.Article, a category populates Document360.Core.Models.Public.DocumentCustomer.Category. Lets callers resolve either kind of resource from a single URL lookup." }, "DocumentSettings": { "type": "object", "properties": { "seo_title": { "type": "string", "description": "The SEO title of the document.", "nullable": true }, "description": { "type": "string", "description": "The SEO description of the document.", "nullable": true }, "exclude_from_external_search": { "type": "boolean", "description": "Returns true if the document is excluded from external search engines. When enabled, Document360 automatically adds a robots meta tag and removes the document from the sitemap it generates." } }, "additionalProperties": false }, "DocumentTypeCustomer": { "enum": [ "article", "category" ], "type": "string", "description": "Represents the type of document retrieved by URL", "x-enumNames": [ "Article", "Category" ], "x-enum-varnames": [ "Article", "Category" ], "x-ms-enum": { "name": "DocumentTypeCustomer", "modelAsString": true } }, "DriveTaskStatus": { "type": "object", "properties": { "task_id": { "type": "string", "description": "The task ID of the file deleted", "nullable": true }, "is_complete": { "type": "boolean", "description": "Indicates whether the task associated with the file deletion is complete" }, "status": { "enum": [ "queued", "initiated", "inProgress", "completed", "error", "cancelled", "waitingForCallback", "partiallyCompleted" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/BackgroundTaskStatus" } ], "description": "0 - Queued, 1 - Initiated, 2 - InProgress, 3 - Completed, 4 - Error, 5 - Cancelled", "x-enumNames": [ "Queued", "Initiated", "InProgress", "Completed", "Error", "Cancelled", "WaitingForCallback", "PartiallyCompleted" ], "x-enum-varnames": [ "Queued", "Initiated", "InProgress", "Completed", "Error", "Cancelled", "WaitingForCallback", "PartiallyCompleted" ], "x-ms-enum": { "name": "BackgroundTaskStatus", "modelAsString": true } } }, "additionalProperties": false, "description": "Status payload for a deferred Drive task (currently used for file deletion)." }, "EditContentRoleCustomer": { "required": [ "content_permissions" ], "type": "object", "properties": { "content_permissions": { "type": "array", "items": { "$ref": "#/components/schemas/ContentPermissionCustomer" }, "description": "Content permissions of the team account. Note that a team account can have multiple content permissions." }, "is_invitation_id": { "type": "boolean", "description": "Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true." } }, "additionalProperties": false }, "EditPortalRoleCustomer": { "required": [ "associated_portal_role_id" ], "type": "object", "properties": { "associated_portal_role_id": { "minLength": 1, "type": "string", "description": "Specify the portal role ID to be assigned for the team account. To get the available roles in the project, use the GET /roles endpoint." }, "is_invitation_id": { "type": "boolean", "description": "Applicable only for SSO users. If temporary invitation ID is passed as team account ID, set this to true." } }, "additionalProperties": false }, "EditUserGroupsCustomer": { "required": [ "associated_groups" ], "type": "object", "properties": { "associated_groups": { "type": "array", "items": { "type": "string" }, "description": "An array of group IDs in which the team account is associated." }, "is_invitation_id": { "type": "boolean", "description": "Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true." } }, "additionalProperties": false }, "EditableElementTypes": { "enum": [ "iconPickerEditElement", "inputTextEditElement", "colorPickerEditElement", "textareaEditElement", "radioGroupEditElement", "cardStyleEditElement", "arrowIndicatorEditElement", "selectBoxEditElement", "checkboxEditElement" ], "type": "string", "description": "Possible values: `\"iconPickerEditElement\"` = IconPickerEditElement, `\"inputTextEditElement\"` = InputTextEditElement, `\"colorPickerEditElement\"` = ColorPickerEditElement, `\"textareaEditElement\"` = TextareaEditElement, `\"radioGroupEditElement\"` = RadioGroupEditElement, `\"cardStyleEditElement\"` = CardStyleEditElement, `\"arrowIndicatorEditElement\"` = ArrowIndicatorEditElement, `\"selectBoxEditElement\"` = SelectBoxEditElement, `\"checkboxEditElement\"` = CheckboxEditElement", "x-enumNames": [ "IconPickerEditElement", "InputTextEditElement", "ColorPickerEditElement", "TextareaEditElement", "RadioGroupEditElement", "CardStyleEditElement", "ArrowIndicatorEditElement", "SelectBoxEditElement", "CheckboxEditElement" ], "x-enum-varnames": [ "IconPickerEditElement", "InputTextEditElement", "ColorPickerEditElement", "TextareaEditElement", "RadioGroupEditElement", "CardStyleEditElement", "ArrowIndicatorEditElement", "SelectBoxEditElement", "CheckboxEditElement" ], "x-ms-enum": { "name": "EditableElementTypes", "modelAsString": true } }, "EmailExists": { "type": "object", "properties": { "exists": { "type": "boolean", "description": "A boolean flag indicating if the user exists in the project or not" }, "user_id": { "type": "string", "description": "The user ID associated with the email. Will be null if the email address does not exist in the project.", "nullable": true } }, "additionalProperties": false }, "EmailExistsResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EmailExists" } ], "description": "Response that checks if the given email address exists in the project", "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 }, "ExportDocumentationRequest": { "type": "object", "properties": { "entity": { "type": "string", "description": "Entity type to export. Allowed values: \"Project\", \"Version\", \"Category\"", "nullable": true, "example": "Version" }, "version_id": { "type": "array", "items": { "type": "string" }, "description": "Array of version IDs to export. Required when Entity is \"Version\". Use empty array [] for \"Project\" entity.", "nullable": true, "example": [ "695782c0-a0a3-4664-9bfd-0197d26379ee" ] }, "selected_languages": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageMeta" }, "description": "Optional list of languages to include in the export. Leave empty or null to export all languages.", "nullable": true }, "selected_categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryMeta" }, "description": "List of categories to include in the export. Required when Entity is \"Category\". Leave empty or null for \"Project\" or \"Version\" entities to export all categories.", "nullable": true }, "exclude_media_files": { "type": "boolean", "description": "Set to true to exclude media files (images, attachments) from the export, reducing file size. Default is false.", "example": false }, "filter_by_article_modified_at": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "Optional date range filter to export only articles modified within the specified period.", "nullable": true }, "export_type": { "enum": [ "json", "webHelp" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ExportType" } ], "description": "Export format type. 0 = JSON format (default), 1 = HTML (Offline Documentation).", "example": "0", "x-enumNames": [ "JSON", "WebHelp" ], "x-enum-varnames": [ "JSON", "WebHelp" ], "x-ms-enum": { "name": "ExportType", "modelAsString": true } } }, "additionalProperties": false }, "ExportDocumentationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the export request. Use this ID to get export details", "nullable": true, "readOnly": true }, "status": { "type": "string", "description": "Current status of the export", "nullable": true, "example": "Initiated" }, "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 }, "ExportDocumentationStatusResponse": { "type": "object", "properties": { "status": { "type": "string", "description": "Current status of the export and it can be either one of these status 'Initiated/InProgress/Completed/Error'", "nullable": true }, "download_url": { "type": "string", "description": "Exported .zip file URL. The download URL will be available when the export status is completed", "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 }, "ExportType": { "enum": [ "json", "webHelp" ], "type": "string", "description": "Possible values: `\"json\"` = JSON, `\"webHelp\"` = WebHelp", "x-enumNames": [ "JSON", "WebHelp" ], "x-enum-varnames": [ "JSON", "WebHelp" ], "x-ms-enum": { "name": "ExportType", "modelAsString": true } }, "ExtensionDataObject": { "type": "object", "additionalProperties": false }, "ExternalSourceType": { "enum": [ "all", "webpage", "sitemap", "crawlLink", "text", "file", "faq", "freshdeskSupportTicket", "freshdeskHelpCenter", "zendeskSupportTicket", "zendeskHelpCenter" ], "type": "string", "description": "Possible values: `\"all\"` = All, `\"webpage\"` = Webpage, `\"sitemap\"` = Sitemap, `\"crawlLink\"` = CrawlLink, `\"text\"` = Text, `\"file\"` = File, `\"faq\"` = FAQ, `\"freshdeskSupportTicket\"` = FreshdeskSupportTicket, `\"freshdeskHelpCenter\"` = FreshdeskHelpCenter, `\"zendeskSupportTicket\"` = ZendeskSupportTicket, `\"zendeskHelpCenter\"` = ZendeskHelpCenter", "x-enumNames": [ "All", "Webpage", "Sitemap", "CrawlLink", "Text", "File", "FAQ", "FreshdeskSupportTicket", "FreshdeskHelpCenter", "ZendeskSupportTicket", "ZendeskHelpCenter" ], "x-enum-varnames": [ "All", "Webpage", "Sitemap", "CrawlLink", "Text", "File", "FAQ", "FreshdeskSupportTicket", "FreshdeskHelpCenter", "ZendeskSupportTicket", "ZendeskHelpCenter" ], "x-ms-enum": { "name": "ExternalSourceType", "modelAsString": true } }, "FeatureAnalytics": { "type": "object", "properties": { "section": { "enum": [ "all", "createKnowledgeBaseArticle", "inviteTeamMembers", "extensions", "homePageBuilder", "advanced" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SectionTypeEnum" } ], "description": "Possible values: `\"all\"` = All, `\"createKnowledgeBaseArticle\"` = CreateKnowledgeBaseArticle, `\"inviteTeamMembers\"` = InviteTeamMembers, `\"extensions\"` = Extensions, `\"homePageBuilder\"` = HomePageBuilder, `\"advanced\"` = Advanced", "x-enumNames": [ "All", "CreateKnowledgeBaseArticle", "InviteTeamMembers", "Extensions", "HomePageBuilder", "Advanced" ], "x-enum-varnames": [ "All", "CreateKnowledgeBaseArticle", "InviteTeamMembers", "Extensions", "HomePageBuilder", "Advanced" ], "x-ms-enum": { "name": "SectionTypeEnum", "modelAsString": true } }, "feature_name": { "enum": [ "all", "publishArticle", "addCategory", "articleImport", "inviteTeamMember", "createRoles", "inviteReaders", "addExtensions", "publishLandingPage", "addContributors", "addWorkFlow", "compareVersions", "articleReviewReminder", "addFiles", "seo", "design", "navigations", "customCSSandJS", "smartBars", "setCookieConsent", "apiTokens", "projectBackup", "addCustomDomain", "createSecurityGroup", "auditing", "analytics", "ipRestriction" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/FeatureListEnum" } ], "description": "Possible values: `\"all\"` = All, `\"publishArticle\"` = PublishArticle, `\"addCategory\"` = AddCategory, `\"articleImport\"` = ArticleImport, `\"inviteTeamMember\"` = InviteTeamMember, `\"createRoles\"` = CreateRoles, `\"inviteReaders\"` = InviteReaders, `\"addExtensions\"` = AddExtensions, `\"publishLandingPage\"` = PublishLandingPage, `\"addContributors\"` = AddContributors, `\"addWorkFlow\"` = AddWorkFlow, `\"compareVersions\"` = CompareVersions, `\"articleReviewReminder\"` = ArticleReviewReminder, `\"addFiles\"` = AddFiles, `\"seo\"` = SEO, `\"design\"` = Design, `\"navigations\"` = Navigations, `\"customCSSandJS\"` = CustomCSSandJS, `\"smartBars\"` = SmartBars, `\"setCookieConsent\"` = SetCookieConsent, `\"apiTokens\"` = APITokens, `\"projectBackup\"` = ProjectBackup, `\"addCustomDomain\"` = AddCustomDomain, `\"createSecurityGroup\"` = CreateSecurityGroup, `\"auditing\"` = Auditing, `\"analytics\"` = Analytics, `\"ipRestriction\"` = IPRestriction", "x-enumNames": [ "All", "PublishArticle", "AddCategory", "ArticleImport", "InviteTeamMember", "CreateRoles", "InviteReaders", "AddExtensions", "PublishLandingPage", "AddContributors", "AddWorkFlow", "CompareVersions", "ArticleReviewReminder", "AddFiles", "SEO", "Design", "Navigations", "CustomCSSandJS", "SmartBars", "SetCookieConsent", "APITokens", "ProjectBackup", "AddCustomDomain", "CreateSecurityGroup", "Auditing", "Analytics", "IPRestriction" ], "x-enum-varnames": [ "All", "PublishArticle", "AddCategory", "ArticleImport", "InviteTeamMember", "CreateRoles", "InviteReaders", "AddExtensions", "PublishLandingPage", "AddContributors", "AddWorkFlow", "CompareVersions", "ArticleReviewReminder", "AddFiles", "SEO", "Design", "Navigations", "CustomCSSandJS", "SmartBars", "SetCookieConsent", "APITokens", "ProjectBackup", "AddCustomDomain", "CreateSecurityGroup", "Auditing", "Analytics", "IPRestriction" ], "x-ms-enum": { "name": "FeatureListEnum", "modelAsString": true } }, "is_feature_explored": { "type": "boolean" }, "time_stamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "FeatureExplorerStatus": { "type": "object", "properties": { "feature_usage_score": { "type": "number", "format": "double" }, "section": { "enum": [ "all", "createKnowledgeBaseArticle", "inviteTeamMembers", "extensions", "homePageBuilder", "advanced" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SectionTypeEnum" } ], "description": "Possible values: `\"all\"` = All, `\"createKnowledgeBaseArticle\"` = CreateKnowledgeBaseArticle, `\"inviteTeamMembers\"` = InviteTeamMembers, `\"extensions\"` = Extensions, `\"homePageBuilder\"` = HomePageBuilder, `\"advanced\"` = Advanced", "x-enumNames": [ "All", "CreateKnowledgeBaseArticle", "InviteTeamMembers", "Extensions", "HomePageBuilder", "Advanced" ], "x-enum-varnames": [ "All", "CreateKnowledgeBaseArticle", "InviteTeamMembers", "Extensions", "HomePageBuilder", "Advanced" ], "x-ms-enum": { "name": "SectionTypeEnum", "modelAsString": true } }, "feature_id": { "type": "string", "nullable": true }, "feature_name": { "enum": [ "all", "publishArticle", "addCategory", "articleImport", "inviteTeamMember", "createRoles", "inviteReaders", "addExtensions", "publishLandingPage", "addContributors", "addWorkFlow", "compareVersions", "articleReviewReminder", "addFiles", "seo", "design", "navigations", "customCSSandJS", "smartBars", "setCookieConsent", "apiTokens", "projectBackup", "addCustomDomain", "createSecurityGroup", "auditing", "analytics", "ipRestriction" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/FeatureListEnum" } ], "description": "Possible values: `\"all\"` = All, `\"publishArticle\"` = PublishArticle, `\"addCategory\"` = AddCategory, `\"articleImport\"` = ArticleImport, `\"inviteTeamMember\"` = InviteTeamMember, `\"createRoles\"` = CreateRoles, `\"inviteReaders\"` = InviteReaders, `\"addExtensions\"` = AddExtensions, `\"publishLandingPage\"` = PublishLandingPage, `\"addContributors\"` = AddContributors, `\"addWorkFlow\"` = AddWorkFlow, `\"compareVersions\"` = CompareVersions, `\"articleReviewReminder\"` = ArticleReviewReminder, `\"addFiles\"` = AddFiles, `\"seo\"` = SEO, `\"design\"` = Design, `\"navigations\"` = Navigations, `\"customCSSandJS\"` = CustomCSSandJS, `\"smartBars\"` = SmartBars, `\"setCookieConsent\"` = SetCookieConsent, `\"apiTokens\"` = APITokens, `\"projectBackup\"` = ProjectBackup, `\"addCustomDomain\"` = AddCustomDomain, `\"createSecurityGroup\"` = CreateSecurityGroup, `\"auditing\"` = Auditing, `\"analytics\"` = Analytics, `\"ipRestriction\"` = IPRestriction", "x-enumNames": [ "All", "PublishArticle", "AddCategory", "ArticleImport", "InviteTeamMember", "CreateRoles", "InviteReaders", "AddExtensions", "PublishLandingPage", "AddContributors", "AddWorkFlow", "CompareVersions", "ArticleReviewReminder", "AddFiles", "SEO", "Design", "Navigations", "CustomCSSandJS", "SmartBars", "SetCookieConsent", "APITokens", "ProjectBackup", "AddCustomDomain", "CreateSecurityGroup", "Auditing", "Analytics", "IPRestriction" ], "x-enum-varnames": [ "All", "PublishArticle", "AddCategory", "ArticleImport", "InviteTeamMember", "CreateRoles", "InviteReaders", "AddExtensions", "PublishLandingPage", "AddContributors", "AddWorkFlow", "CompareVersions", "ArticleReviewReminder", "AddFiles", "SEO", "Design", "Navigations", "CustomCSSandJS", "SmartBars", "SetCookieConsent", "APITokens", "ProjectBackup", "AddCustomDomain", "CreateSecurityGroup", "Auditing", "Analytics", "IPRestriction" ], "x-ms-enum": { "name": "FeatureListEnum", "modelAsString": true } }, "advanced_feature_user_role": { "enum": [ "basic", "contentRole", "portalRole" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/FeatureExplorerUserRoleEnum" } ], "description": "Possible values: `\"basic\"` = Basic, `\"contentRole\"` = ContentRole, `\"portalRole\"` = PortalRole", "x-enumNames": [ "Basic", "ContentRole", "PortalRole" ], "x-enum-varnames": [ "Basic", "ContentRole", "PortalRole" ], "x-ms-enum": { "name": "FeatureExplorerUserRoleEnum", "modelAsString": true } }, "feature_explorer_user_analytics": { "allOf": [ { "$ref": "#/components/schemas/FeatureExplorerUserAnalyticsEntity" } ], "nullable": true } }, "additionalProperties": false }, "FeatureExplorerUserAnalyticsEntity": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "project_id": { "type": "string", "nullable": true }, "user_id": { "type": "string", "nullable": true }, "trophy_status": { "allOf": [ { "$ref": "#/components/schemas/TrophyStatus" } ], "nullable": true }, "show_default": { "type": "boolean" }, "show_advanced_section_popup": { "type": "boolean" }, "hide_popup": { "type": "boolean" }, "hide_popup_date": { "type": "string", "format": "date-time" }, "is_advanced_section_unlocked": { "type": "boolean" }, "usage_score": { "type": "number", "format": "double" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureAnalytics" }, "nullable": true }, "is_closed_content_reuse_info": { "type": "boolean" } }, "additionalProperties": false }, "FeatureExplorerUserRoleEnum": { "enum": [ "basic", "contentRole", "portalRole" ], "type": "string", "description": "Possible values: `\"basic\"` = Basic, `\"contentRole\"` = ContentRole, `\"portalRole\"` = PortalRole", "x-enumNames": [ "Basic", "ContentRole", "PortalRole" ], "x-enum-varnames": [ "Basic", "ContentRole", "PortalRole" ], "x-ms-enum": { "name": "FeatureExplorerUserRoleEnum", "modelAsString": true } }, "FeatureListEnum": { "enum": [ "all", "publishArticle", "addCategory", "articleImport", "inviteTeamMember", "createRoles", "inviteReaders", "addExtensions", "publishLandingPage", "addContributors", "addWorkFlow", "compareVersions", "articleReviewReminder", "addFiles", "seo", "design", "navigations", "customCSSandJS", "smartBars", "setCookieConsent", "apiTokens", "projectBackup", "addCustomDomain", "createSecurityGroup", "auditing", "analytics", "ipRestriction" ], "type": "string", "description": "Possible values: `\"all\"` = All, `\"publishArticle\"` = PublishArticle, `\"addCategory\"` = AddCategory, `\"articleImport\"` = ArticleImport, `\"inviteTeamMember\"` = InviteTeamMember, `\"createRoles\"` = CreateRoles, `\"inviteReaders\"` = InviteReaders, `\"addExtensions\"` = AddExtensions, `\"publishLandingPage\"` = PublishLandingPage, `\"addContributors\"` = AddContributors, `\"addWorkFlow\"` = AddWorkFlow, `\"compareVersions\"` = CompareVersions, `\"articleReviewReminder\"` = ArticleReviewReminder, `\"addFiles\"` = AddFiles, `\"seo\"` = SEO, `\"design\"` = Design, `\"navigations\"` = Navigations, `\"customCSSandJS\"` = CustomCSSandJS, `\"smartBars\"` = SmartBars, `\"setCookieConsent\"` = SetCookieConsent, `\"apiTokens\"` = APITokens, `\"projectBackup\"` = ProjectBackup, `\"addCustomDomain\"` = AddCustomDomain, `\"createSecurityGroup\"` = CreateSecurityGroup, `\"auditing\"` = Auditing, `\"analytics\"` = Analytics, `\"ipRestriction\"` = IPRestriction", "x-enumNames": [ "All", "PublishArticle", "AddCategory", "ArticleImport", "InviteTeamMember", "CreateRoles", "InviteReaders", "AddExtensions", "PublishLandingPage", "AddContributors", "AddWorkFlow", "CompareVersions", "ArticleReviewReminder", "AddFiles", "SEO", "Design", "Navigations", "CustomCSSandJS", "SmartBars", "SetCookieConsent", "APITokens", "ProjectBackup", "AddCustomDomain", "CreateSecurityGroup", "Auditing", "Analytics", "IPRestriction" ], "x-enum-varnames": [ "All", "PublishArticle", "AddCategory", "ArticleImport", "InviteTeamMember", "CreateRoles", "InviteReaders", "AddExtensions", "PublishLandingPage", "AddContributors", "AddWorkFlow", "CompareVersions", "ArticleReviewReminder", "AddFiles", "SEO", "Design", "Navigations", "CustomCSSandJS", "SmartBars", "SetCookieConsent", "APITokens", "ProjectBackup", "AddCustomDomain", "CreateSecurityGroup", "Auditing", "Analytics", "IPRestriction" ], "x-ms-enum": { "name": "FeatureListEnum", "modelAsString": true } }, "FeedbackSubType": { "enum": [ "aiSearchAnswered", "aiSearchUnanswered" ], "type": "string", "description": "Possible values: `\"aiSearchAnswered\"` = aiSearchAnswered, `\"aiSearchUnanswered\"` = aiSearchUnanswered", "x-enumNames": [ "aiSearchAnswered", "aiSearchUnanswered" ], "x-enum-varnames": [ "aiSearchAnswered", "aiSearchUnanswered" ], "x-ms-enum": { "name": "FeedbackSubType", "modelAsString": true } }, "ForkArticleVersionRequest": { "required": [ "lang_code", "user_id", "version_number" ], "type": "object", "properties": { "version_number": { "type": "integer", "description": "The version number of the article to be forked", "format": "int32" }, "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account that will be marked as the contributor of this fork" }, "lang_code": { "minLength": 1, "type": "string", "description": "Language code of the article" } }, "additionalProperties": false }, "ForkArticleVersionResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ArticleSimpleVersionCustomer" } ], "description": "forked article 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 }, "ForkCategoryVersionRequest": { "required": [ "lang_code", "user_id", "version_number" ], "type": "object", "properties": { "version_number": { "type": "integer", "description": "The version number of the category page", "format": "int32" }, "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account" }, "lang_code": { "minLength": 1, "type": "string", "description": "Language code of the category" } }, "additionalProperties": false }, "ForkCategoryVersionResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CategorySimpleVersionCustomer" } ], "description": "category response forked 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 }, "FormEditableProperties": { "type": "object", "properties": { "element_name": { "type": "string", "nullable": true }, "element_type": { "allOf": [ { "$ref": "#/components/schemas/EditableElementTypes" } ], "nullable": true }, "label": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "view_form_control": { "allOf": [ { "$ref": "#/components/schemas/ViewFormControl" } ], "nullable": true }, "editable_properties": { "allOf": [ { "$ref": "#/components/schemas/FormEditableProperties" } ], "nullable": true }, "element_guid": { "type": "string", "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/FormEditableProperties" }, "nullable": true }, "edit_component_style_properties": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "edit_component_properties": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true } }, "additionalProperties": false }, "GetApiReferenceDataResponseCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ApiDefinitionInforamtionCustomer" }, "description": "The API references imported into the workspace.", "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, "description": "Response wrapper for `GET /v2/projectversions/{projectVersionId}/apireferences` — lists API references imported into a workspace." }, "GetArticleByUrlResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ArticleDataBySlugCustomer" } ], "description": "Contains details of the retrieved document, which can be an article or a category.", "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, "description": "Response for retrieving an article by URL.\r\nExtends the standard article response with available_languages and settings." }, "GetArticleNotTranslatedResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NeedTranslationArticleData" }, "description": "Article need to be translated", "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 }, "GetArticleResponseCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ArticleVersionDataCustomerResponse" } ], "description": "Article 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 }, "GetArticleSettingsResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ArticleSettingCustomer" } ], "description": "Get article settings", "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 }, "GetArticleVersionResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ArticleVersionInfoCustomerResponse" } ], "description": "Get article 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 }, "GetArticleVersionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleSimpleVersionCustomer" }, "description": "Article version response 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 }, "GetArticlesResponseCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleSimpleDataCustomerResponse" }, "nullable": true }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/PaginationInfo" } ], "nullable": true, "readOnly": 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 }, "GetCategoriesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectCategoryDataCustomer" }, "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 }, "GetCategoryByUrlResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CategoryDataBySlugCustomer" } ], "description": "Contains details of the retrieved document, which can be an article or a category.", "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, "description": "Response for getting a category by URL" }, "GetCategoryContentResponse": { "type": "object", "properties": { "category": { "allOf": [ { "$ref": "#/components/schemas/CategoryVersionData" } ], "description": "Get category version 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 }, "GetCategoryResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CategoryDataCustomer" } ], "description": "Full category payload — extends Document360.Core.Models.Public.Categories.CategoryDataBaseCustomer with the articles and child categories that live inside this category. Forms the recursive tree returned by `GET /v2/projectversions/{projectVersionId}/categories`.", "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 }, "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 }, "GetCategoryVersionsResponse": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/CategorySimpleVersionCustomer" }, "description": "get category data by version", "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 }, "GetCustomFieldDefinitionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldDefinitionResponse" }, "description": "List of custom field definitions for the project", "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, "description": "Response for getting custom field definitions" }, "GetCustomerTaskStatusResponse": { "type": "object", "properties": { "task_status": { "allOf": [ { "$ref": "#/components/schemas/DriveTaskStatus" } ], "description": "The current status of the delete-file task.", "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, "description": "Response wrapper for `GET /v2/drive/Folders/DeleteFile/Status/{taskId}` — the current status of a deferred Drive task." }, "GetDocumentByPathResponseCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DocumentCustomer" } ], "description": "Contains details of the retrieved document, which can be an article or a category.", "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, "description": "Response containing a document (article or category) retrieved by URL path" }, "GetDriveFilesInArticleDataCustomer": { "type": "object", "properties": { "article_id": { "type": "string", "description": "Id of the Article", "nullable": true }, "file_urls": { "type": "array", "items": { "type": "string" }, "description": "List of media files in the article", "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, "description": "Response wrapper for `GET /v2/drive/MediaFiles/{projectVersionId}/{articleId}/{langCode}` — lists the Drive file URLs referenced by an article." }, "GetLanguageFromProjectVersion": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectLanguage" }, "description": "All Language data in a poject", "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 }, "GetLogsDetailsResponseCustomer": { "type": "object", "properties": { "api_reference_errors": { "type": "array", "items": { "$ref": "#/components/schemas/ApiLogs" }, "description": "Error log response", "nullable": true }, "api_reference_alerts": { "type": "array", "items": { "$ref": "#/components/schemas/ApiLogs" }, "description": "Alerts log response", "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 }, "GetMediaFolderResponseCustomer": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFoldersDataCustomer" }, "description": "Drive folder metadata. The top-level folders in the project's Drive.", "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, "description": "Response wrapper for `GET /v2/drive/Folders` — the top-level folder tree for the project's Drive." }, "GetMediaFolderWithIdCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MediaFolderViewMetaDataCustomer" } ], "description": "Drive folder metadata for the requested folder, including files and child folders.", "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, "description": "Response wrapper for `GET /v2/drive/Folders/{folderId}` — a single folder with its files and child folders." }, "GetProjectVersionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectVersionCustomer" }, "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 }, "GetReaderResponseCustomer": { "type": "object", "properties": { "reader_id": { "type": "string", "description": "The ID of the reader.", "nullable": true }, "first_name": { "type": "string", "description": "The first name of the reader.", "nullable": true }, "last_name": { "type": "string", "description": "The last name of the reader.", "nullable": true }, "email": { "type": "string", "description": "Email address of the reader.", "nullable": true }, "access_scope": { "allOf": [ { "$ref": "#/components/schemas/AccessScopeCustomerV2" } ], "description": "The access scope of the reader.", "nullable": true }, "associated_reader_groups": { "type": "array", "items": { "type": "string" }, "description": "An array of the group IDs the reader is associated with.", "nullable": true }, "is_invite_sso_user": { "type": "boolean", "description": "Applicable only for SSO readers. If true, it indicates that an invitation has been sent to the reader, but the reader hasn't accepted the invitation yet." }, "last_login_at": { "type": "string", "description": "The last login date and time by the reader.", "format": "date-time", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GetWorkflowStatusResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowStatusCustomer" }, "description": "Contains the list of workflow statuses configured for the current project. Each object represents a single workflow status definition.", "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 }, "GroupInfo": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "title": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "content_role_infos": { "type": "array", "items": { "$ref": "#/components/schemas/ContentRoleInfo" }, "nullable": true } }, "additionalProperties": false }, "GuideAccessInfo": { "type": "object", "properties": { "guide_name": { "type": "string", "nullable": true }, "category_name": { "type": "string", "nullable": true }, "category_id": { "type": "string", "nullable": true }, "language_id": { "type": "string", "nullable": true }, "language_name": { "type": "string", "nullable": true }, "language_code": { "type": "string", "nullable": true }, "version_name": { "type": "string", "nullable": true }, "version_id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Hit": { "type": "object", "properties": { "title": { "type": "string", "description": "Article title", "nullable": true }, "content": { "type": "string", "description": "Article HTML content", "nullable": true }, "is_hidden": { "type": "boolean", "description": "Indicates if the article is visible on the site", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Custom article tags", "nullable": true }, "slug": { "type": "string", "description": "The slug of the article", "nullable": true, "readOnly": true }, "version": { "type": "integer", "description": "The version number that is currently published", "format": "int32", "nullable": true }, "article_id": { "type": "string", "description": "The ID of the article", "nullable": true }, "category_id": { "type": "string", "description": "The ID of the category", "nullable": true }, "is_category_hidden": { "type": "boolean", "description": "Indicates if category is visible on the site", "nullable": true }, "order": { "type": "integer", "description": "The position inside the parent category. Always a valid integer: a search-index record that\r\ncarries no order (or an explicit null, as some historically-written records do) surfaces as 0.", "format": "int32" }, "is_draft": { "type": "boolean", "description": "Indicates if the article is marked as a draft", "nullable": true }, "is_unpublished": { "type": "boolean", "description": "Indicates that this record is the article's UNPUBLISHED version. The index carries a separate\r\nrecord-set per publish state, so a hit is published when neither isDraft nor isUnpublished is set.\r\nFiltered on by every search path; exposed here so a caller can report the state it matched.", "nullable": true }, "exclude": { "type": "boolean", "description": "Indicates if the article is excluded from search results on user website", "nullable": true }, "breadcrumb": { "type": "string", "description": "The breadcrumb of the article", "nullable": true }, "is_category": { "type": "boolean", "description": "If the value is True, then the object has to considered as a category, otherwise it is an article", "nullable": true }, "attachment_ids": { "type": "array", "items": { }, "description": "The IDs of the files attached to the article", "nullable": true }, "is_deleted": { "type": "boolean", "description": "If the value is True, then it indicates that the article has been deleted", "nullable": true }, "is_folder_type_category": { "type": "boolean", "description": "If the value is True, then it indicates that the category is a folder type category", "nullable": true }, "updated_on_timestamp": { "type": "number", "description": "The last updated timestamp of the article", "format": "double", "nullable": true }, "is_private": { "type": "boolean", "description": "If the value is True, then the article can only be accessed by logged in users in the knowledge base site", "nullable": true }, "language_id": { "type": "string", "description": "The ID of the language", "nullable": true }, "project_id": { "type": "string", "description": "The ID of the project", "nullable": true }, "is_latest_version": { "type": "boolean", "description": "If the value is True, then the article is the latest version", "nullable": true }, "contributors": { "type": "array", "items": { "type": "string" }, "description": "The IDs of users who have contributed to the article", "nullable": true }, "is_shared_article": { "type": "integer", "description": "If the value is True, then it indicates that it is a shared article", "format": "int32", "nullable": true }, "lang_code": { "type": "string", "description": "The language code of the article or category", "nullable": true }, "category_unique_id": { "type": "string", "description": "A unique identifier for the category which is a combination of category ID and the language code", "nullable": true }, "unique_id": { "type": "string", "description": "A unique identifier for the article which is a combination of article ID and the language code", "nullable": true }, "deleted_by": { "type": "string", "description": "The ID of the user who deleted the article", "nullable": true }, "deleted_at": { "type": "string", "description": "The timestamp when the article was deleted", "nullable": true }, "is_git_hub_entity": { "type": "boolean", "description": "If the value is True, then it indicates that the article is synced from GitHub", "nullable": true }, "original_article_id": { "type": "string", "description": "The original article ID. Applicable only for shared articles.", "nullable": true }, "object_id": { "type": "string", "description": "algolia search object ID", "nullable": true }, "_snippet_result": { "allOf": [ { "$ref": "#/components/schemas/_Snippetresult" } ], "description": "Markup text with occurrences highlighted.", "nullable": true }, "_highlight_result": { "allOf": [ { "$ref": "#/components/schemas/_Highlightresult" } ], "description": "Highlighted attributes", "nullable": true } }, "additionalProperties": false }, "ImportAPILog": { "type": "object", "properties": { "new_versions": { "type": "integer", "description": "The number of versions imported", "format": "int32" }, "categories": { "type": "integer", "description": "The number of categories imported", "format": "int32" }, "articles": { "type": "integer", "description": "The number of articles imported", "format": "int32" }, "languages": { "type": "string", "description": "The number of languages imported", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ImportDocumentationLogAction" }, "nullable": true } }, "additionalProperties": false }, "ImportDocumemtationLogMessageType": { "enum": [ "error", "warning", "info" ], "type": "string", "description": "Possible values: `\"error\"` = Error, `\"warning\"` = Warning, `\"info\"` = Info", "x-enumNames": [ "Error", "Warning", "Info" ], "x-enum-varnames": [ "Error", "Warning", "Info" ], "x-ms-enum": { "name": "ImportDocumemtationLogMessageType", "modelAsString": true } }, "ImportDocumentationLogAction": { "type": "object", "properties": { "message_type": { "enum": [ "error", "warning", "info" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ImportDocumemtationLogMessageType" } ], "description": "0 - Error; 1 - Warning; 2 - Info", "x-enumNames": [ "Error", "Warning", "Info" ], "x-enum-varnames": [ "Error", "Warning", "Info" ], "x-ms-enum": { "name": "ImportDocumemtationLogMessageType", "modelAsString": true } }, "message": { "type": "string", "description": "The content of the message", "nullable": true }, "cancel_operation": { "type": "boolean" } }, "additionalProperties": false }, "ImportDocumentationRequest": { "type": "object", "properties": { "source_documentation_url": { "type": "string", "description": "Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB", "nullable": true }, "publish_article": { "type": "boolean", "description": "Import article and publish." }, "import_by": { "type": "string", "description": "Document360 user-id", "nullable": true } }, "additionalProperties": false }, "ImportDocumentationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the import request. Use this ID to get the import details", "nullable": true, "readOnly": true }, "status": { "type": "string", "description": "Current status of the import", "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 }, "ImportDocumentationStatusResponse": { "type": "object", "properties": { "import_documentation_log": { "allOf": [ { "$ref": "#/components/schemas/ImportAPILog" } ], "description": "Details about the import", "nullable": true }, "status": { "type": "string", "description": "Current status of the import and it can be either one of these statuses 'Queued/InProgress/Completed/Error'", "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 }, "Language": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "set_as_default": { "type": "boolean" }, "hidden": { "type": "boolean" }, "enable_rtl": { "type": "boolean" }, "site_protection_level": { "enum": [ "public", "protected", "mixed" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProjectProtection" } ], "description": "Possible values: `\"public\"` = Public, `\"protected\"` = Protected, `\"mixed\"` = Mixed", "x-enumNames": [ "Public", "Protected", "Mixed" ], "x-enum-varnames": [ "Public", "Protected", "Mixed" ], "x-ms-enum": { "name": "ProjectProtection", "modelAsString": true } }, "is_inheritance_disabled": { "type": "boolean" }, "is_kb_inheritance_disabled": { "type": "boolean" }, "has_inheritance_disabled_categories_or_articles": { "type": "boolean" }, "has_kb_inheritance_disabled_categories_or_articles": { "type": "boolean" }, "country_flag_code": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "is_home_page_enabled": { "type": "boolean" }, "version_display_name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LanguageAccessInfo": { "type": "object", "properties": { "language_id": { "type": "string", "nullable": true }, "language_name": { "type": "string", "nullable": true }, "language_code": { "type": "string", "nullable": true }, "version_name": { "type": "string", "nullable": true }, "version_id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LanguageMeta": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the language version", "nullable": true, "readOnly": true, "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "code": { "type": "string", "description": "Language code (e.g., \"en\" for English, \"es\" for Spanish, \"fr\" for French, \"de\" for German)", "nullable": true, "example": "en" }, "version_id": { "type": "string", "nullable": true } }, "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 }, "LanguageSummaryCustomer": { "type": "object", "properties": { "project_version_id": { "type": "string", "description": "The project version ID to which the user should be given access.", "nullable": true }, "language_code": { "type": "string", "description": "The language to which the user should be given access.", "nullable": true } }, "additionalProperties": false, "description": "Pair of (workspace, language) used to scope reader/group access — describes which language inside which workspace the entity should be granted access to." }, "LanguageTranslationOption": { "enum": [ "none", "needTranslation", "translated", "inProgress" ], "type": "string", "description": "0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress", "x-enumNames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-enum-varnames": [ "None", "NeedTranslation", "Translated", "InProgress" ], "x-ms-enum": { "name": "LanguageTranslationOption", "modelAsString": true } }, "MediaFileAndTagsMetaDataCustomer": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "The file ID", "readOnly": true }, "file_name": { "type": "string", "description": "The file name", "nullable": true }, "file_type": { "type": "string", "description": "The file type", "nullable": true }, "file_url": { "type": "string", "description": "The file URL", "nullable": true }, "updated_on": { "type": "string", "description": "The date the file was uploaded", "format": "date-time", "readOnly": true }, "updated_by": { "type": "string", "description": "The ID of user who uploaded the file", "nullable": true }, "size": { "type": "string", "description": "The file size", "nullable": true }, "height": { "type": "string", "description": "The file height", "nullable": true }, "width": { "type": "string", "description": "The file width", "nullable": true }, "parent_folder_id": { "type": "string", "description": "The parent folder ID", "nullable": true }, "title": { "type": "string", "description": "The file title", "nullable": true }, "alternative_text": { "type": "string", "description": "The file alternative text", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagsMetaDataCustomer" }, "description": "The tags associated with the file", "nullable": true }, "thumbnail_url": { "type": "string", "description": "The thumbnail URL", "nullable": true }, "is_starred": { "type": "boolean", "description": "This denotes the file is starred or not" } }, "additionalProperties": false }, "MediaFileAndTagsMetaDataResponseCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MediaFileAndTagsMetaDataCustomer" } ], "description": "File response with tag 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 }, "MediaFileDataResponseCustomer": { "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 }, "MediaFileMetaDataCustomer": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "Media file Id", "readOnly": true }, "title": { "type": "string", "nullable": true }, "file_name": { "type": "string", "description": "The file name", "nullable": true }, "file_type": { "type": "string", "description": "The file type", "nullable": true }, "file_url": { "type": "string", "description": "The file URL", "nullable": true }, "updated_by": { "type": "string", "description": "The ID of the user who uploaded the file", "nullable": true }, "media_folder_id": { "type": "string", "description": "The parent Folder ID", "nullable": true } }, "additionalProperties": false }, "MediaFilesMetaDataCustomer": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string", "description": "The file ID", "readOnly": true }, "file_name": { "type": "string", "description": "The file name", "nullable": true }, "file_type": { "type": "string", "description": "The file tyoe", "nullable": true }, "file_url": { "type": "string", "description": "The file URL", "nullable": true }, "updated_on": { "type": "string", "description": "The date file was modified", "format": "date-time", "readOnly": true }, "updated_by": { "type": "string", "description": "The ID of the user who uploaded the file", "nullable": true }, "size": { "type": "string", "description": "The file size", "nullable": true }, "height": { "type": "string", "description": "The file height", "nullable": true }, "width": { "type": "string", "description": "The file width", "nullable": true }, "title": { "type": "string", "description": "The file title", "nullable": true }, "alternative_text": { "type": "string", "description": "The file alternative text", "nullable": true }, "thumbnail_url": { "type": "string", "description": "The thumbnail URL", "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagsMetaDataCustomer" }, "description": "The tags associated with file", "nullable": true }, "is_starred": { "type": "boolean", "description": "This denotes the file is starred or not" } }, "additionalProperties": false }, "MediaFolderMetaDataCustomer": { "type": "object", "properties": { "media_folder_id": { "type": "string", "description": "The folder ID", "nullable": true }, "media_folder_title": { "type": "string", "description": "The folder title", "nullable": true }, "order": { "type": "integer", "description": "The folder order", "format": "int32" }, "icon": { "type": "string", "description": "The folder icon", "nullable": true }, "updated_on": { "type": "string", "description": "The date the file was modified", "format": "date-time", "readOnly": true }, "folder_color": { "type": "string", "description": "The folder color", "nullable": true }, "is_starred": { "type": "boolean", "description": "This denotes the file is starred or not" }, "updated_by": { "type": "string", "description": "The ID of the user who uploaded the folder", "nullable": true }, "parent_media_folder_id": { "type": "string", "description": "The parent folder ID", "nullable": true } }, "additionalProperties": false }, "MediaFolderMetaDataResponseCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/MediaFolderMetaDataCustomer" } ], "description": "Media folder response meta 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 }, "MediaFolderViewMetaDataCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the folder in Drive", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "This folder title", "nullable": true }, "order": { "type": "integer", "description": "The order of the folder", "format": "int32" }, "parent_folder_id": { "type": "string", "description": "The parent folder ID", "nullable": true }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFilesMetaDataCustomer" }, "description": "The files associated to the folder", "nullable": true }, "icon": { "type": "string", "description": "The icon of the folder", "nullable": true }, "items_count": { "type": "integer", "description": "Subfolder count in the folder", "format": "int32" }, "updated_on": { "type": "string", "description": "The date the folder was created", "format": "date-time", "readOnly": true }, "updated_by": { "type": "string", "description": "The ID of the user that created the folder", "nullable": true }, "is_starred": { "type": "boolean", "description": "This denotes the folder is starred or not" }, "folder_color": { "type": "string", "description": "The folder color", "nullable": true }, "files_count": { "type": "integer", "description": "The folder file count", "format": "int32" }, "sub_folders": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFoldersDataCustomer" }, "description": "Sub folders of the media folder", "nullable": true } }, "additionalProperties": false }, "MediaFoldersDataCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "This is the folder Id", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "This is the folder title", "nullable": true }, "parent_folder_id": { "type": "string", "description": "The parent folder ID", "nullable": true }, "sub_folders": { "type": "array", "items": { "$ref": "#/components/schemas/MediaFoldersDataCustomer" }, "description": "The sub folders in the parent", "nullable": true }, "items_count": { "type": "integer", "description": "The items in the folder", "format": "int32" }, "updated_by": { "type": "string", "description": "The ID of the user that created the folder", "nullable": true }, "created_at": { "type": "string", "description": "The date the folder was created", "format": "date-time", "nullable": true, "readOnly": true }, "updated_on": { "type": "string", "description": "The date the folder was last updated", "format": "date-time", "readOnly": true }, "order": { "type": "integer", "description": "The order of the folder", "format": "int32" }, "is_starred": { "type": "boolean", "description": "This denotes the folder is starred or not" }, "folder_color": { "type": "string", "description": "The hex color code of the folder icon", "nullable": true } }, "additionalProperties": false, "description": "Folder metadata for a Drive folder — identity, position, sub-folder tree, item count, and audit timestamps." }, "NeedTranslationArticleData": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the article", "nullable": true, "readOnly": true }, "category_id": { "type": "string", "description": "The ID of the category", "nullable": true } }, "additionalProperties": false }, "PaginationInfo": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32", "nullable": true }, "hits_per_page": { "type": "integer", "format": "int32", "nullable": true }, "has_more": { "type": "boolean", "nullable": true }, "result_count": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ProjectCategoryDataCustomer": { "type": "object", "properties": { "articles": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleSimpleDataCustomerResponse" }, "description": "The list of articles attached to this category", "nullable": true }, "child_categories": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectCategoryDataCustomer" }, "description": "The list of categories attached to this category", "nullable": true }, "exclude_from_external_search": { "type": "boolean", "description": "Returns true if the document is excluded from external search engines. When enabled, Document360 automatically adds a robots meta tag and removes the document from the sitemap it generates." }, "security_visibility": { "enum": [ "public", "private" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SecurityVisibility" } ], "description": "Indicates the visibility level of the article.Valid values are: \r\n0 – Public(accessible to all readers)\r\n1 – Private(accessible only to authenticated users or specific teams).", "x-enumNames": [ "Public", "Private" ], "x-enum-varnames": [ "Public", "Private" ], "x-ms-enum": { "name": "SecurityVisibility", "modelAsString": true } }, "id": { "type": "string", "description": "The ID of the category", "nullable": true, "readOnly": true }, "name": { "type": "string", "description": "Name of the category", "nullable": true }, "description": { "type": "string", "description": "Description of the category", "nullable": true }, "project_version_id": { "type": "string", "description": "The ID of the project version where this category is located", "nullable": true }, "order": { "type": "integer", "description": "The position the category inside the parent category", "format": "int32" }, "parent_category_id": { "type": "string", "description": "The ID of the parent category ( null if top-level )", "nullable": true }, "hidden": { "type": "boolean", "description": "Indicates if the category is visible on the site ( If \"false,\" all the child categories and articles will be hidden as well )" }, "icon": { "type": "string", "description": "Unicode representation of the icon or image URL", "nullable": true }, "slug": { "type": "string", "description": "The slug of the category", "nullable": true, "readOnly": true }, "language_code": { "type": "string", "description": "Language code of the category", "nullable": true }, "category_type": { "enum": [ "default", "customContent", "linksToArticle" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CategoryType" } ], "description": "0 - Folder, 1 - Page, 2 - Index", "x-enumNames": [ "Default", "CustomContent", "LinksToArticle" ], "x-enum-varnames": [ "Default", "CustomContent", "LinksToArticle" ], "x-ms-enum": { "name": "CategoryType", "modelAsString": true } }, "created_at": { "type": "string", "description": "Category created date time", "format": "date-time", "nullable": true, "readOnly": true }, "modified_at": { "type": "string", "description": "Category modified date time", "format": "date-time", "nullable": true, "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/ArticleStatusCustomer" } ], "description": "The status of the page type category: 0 - Draft, 3 - Published", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The content type of the page type category: Markdown = 0, Wysiwyg = 1, Block = 2", "nullable": true }, "current_workflow_status_id": { "type": "string", "description": "Current Workflow status of the article", "nullable": true } }, "additionalProperties": false }, "ProjectLanguage": { "type": "object", "properties": { "language_id": { "type": "string", "description": "The ID of the language", "nullable": true }, "language_code": { "type": "string", "description": "The code of the language", "nullable": true }, "language_name": { "type": "string", "description": "The name of the language", "nullable": true }, "is_set_as_default": { "type": "boolean", "description": "`True` - Default language of the version; `False` - Non-default language of the version" }, "country_flag_code": { "type": "string", "description": "The code of the country flag", "nullable": true } }, "additionalProperties": false }, "ProjectProtection": { "enum": [ "public", "protected", "mixed" ], "type": "string", "description": "Possible values: `\"public\"` = Public, `\"protected\"` = Protected, `\"mixed\"` = Mixed", "x-enumNames": [ "Public", "Protected", "Mixed" ], "x-enum-varnames": [ "Public", "Protected", "Mixed" ], "x-ms-enum": { "name": "ProjectProtection", "modelAsString": true } }, "ProjectVersionCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the project version", "nullable": true, "readOnly": true }, "version_number": { "type": "number", "description": "Project version number", "format": "double" }, "base_version_number": { "type": "number", "description": "The version number from which this version is derived", "format": "double" }, "version_code_name": { "type": "string", "description": "Custom version name", "nullable": true }, "is_main_version": { "type": "boolean", "description": "\"True\" if this version is the main version after loading documentation" }, "is_beta": { "type": "boolean", "description": "\"True\" if this version is marked as Beta" }, "is_public": { "type": "boolean", "description": "\"True\" if this version is visible to the public" }, "is_deprecated": { "type": "boolean", "description": "\"True\" if this version is marked as deprecated" }, "created_at": { "type": "string", "description": "The date and time the version was created", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "description": "The last date and time the version was modified", "format": "date-time", "readOnly": true }, "language_versions": { "type": "array", "items": { "$ref": "#/components/schemas/Language" }, "nullable": true }, "slug": { "type": "string", "nullable": true, "readOnly": true }, "order": { "type": "integer", "format": "int32" }, "version_type": { "enum": [ "knowledgeBase", "apiDocumentation" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ProjectVersionTypeCustomer" } ], "description": "0 - KB workspace ; 1 - API Reference workspace;", "x-enumNames": [ "KnowledgeBase", "ApiDocumentation" ], "x-enum-varnames": [ "KnowledgeBase", "ApiDocumentation" ], "x-ms-enum": { "name": "ProjectVersionTypeCustomer", "modelAsString": true } } }, "additionalProperties": false, "description": "Full workspace (project version) payload — identity, version number, visibility flags, languages, and modification metadata. Returned by `GET /v2/projectversions`. The `Id` field is what other endpoints accept as `projectVersionId`." }, "ProjectVersionTypeCustomer": { "enum": [ "knowledgeBase", "apiDocumentation" ], "type": "string", "description": "0 - KB workspace , 1 - API Reference workspace", "x-enumNames": [ "KnowledgeBase", "ApiDocumentation" ], "x-enum-varnames": [ "KnowledgeBase", "ApiDocumentation" ], "x-ms-enum": { "name": "ProjectVersionTypeCustomer", "modelAsString": true } }, "PublicAPIAIFeedbackRequest": { "type": "object", "properties": { "entity_id": { "type": "string", "description": "Analytics ID returned by the ask-eddy response. Required to associate feedback with an ask-eddy query.", "nullable": true }, "is_liked": { "type": "boolean", "description": "Set to `true` if the user liked the AI response, and `false` if the user disliked the response." }, "comments": { "type": "string", "description": "Optional user-provided feedback or suggestions about the AI response.", "nullable": true }, "notify_me_about_changes": { "type": "boolean", "description": "Set to `true` if the user wants to be notified when there is a response to their feedback." }, "feedback_provider_email": { "type": "string", "description": "Email address of the user submitting the feedback. Required if `notify_me_about_changes` is set to `true`.", "nullable": true }, "additional_feedback_info": { "allOf": [ { "$ref": "#/components/schemas/AIAdditionalFeedbackInfo" } ], "description": "Additional details about the user’s feedback. Helps categorize user feedback and respond effectively.", "nullable": true }, "feedback_sub_type": { "enum": [ "aiSearchAnswered", "aiSearchUnanswered" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/FeedbackSubType" } ], "description": "Set to `0` if the user did not receive a response to their query. Set to `1` if they received a response but were not satisfied with it.", "x-enumNames": [ "aiSearchAnswered", "aiSearchUnanswered" ], "x-enum-varnames": [ "aiSearchAnswered", "aiSearchUnanswered" ], "x-ms-enum": { "name": "FeedbackSubType", "modelAsString": true } } }, "additionalProperties": false }, "PublishArticleRequest": { "required": [ "user_id", "version_number" ], "type": "object", "properties": { "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account that will be marked as the contributor of this publish" }, "version_number": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The version number of the article to be published", "format": "int32" }, "publish_message": { "type": "string", "description": "The publish message of the article", "nullable": true } }, "additionalProperties": false }, "PublishCategoryRequest": { "required": [ "user_id", "version_number" ], "type": "object", "properties": { "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account who is responsible for the publish" }, "version_number": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The version number of the category", "format": "int32" }, "publish_message": { "type": "string", "description": "Publish message for the category", "nullable": true } }, "additionalProperties": false }, "ReaderGroupCustomerV2": { "type": "object", "properties": { "reader_group_id": { "type": "string", "description": "The ID of the reader group.", "nullable": true }, "title": { "type": "string", "description": "The name of the reader group.", "nullable": true }, "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.", "nullable": true }, "associated_invited_sso_users": { "type": "array", "items": { "type": "string" }, "description": "List of reader invitation IDs. Applicable only for SSO readers.", "nullable": true }, "access_scope": { "allOf": [ { "$ref": "#/components/schemas/AccessScopeCustomerV2" } ], "description": "Access scope of this reader group.", "nullable": true } }, "additionalProperties": false, "description": "V2 reader-group payload — group identity, associated readers (by ID), pending SSO invitations, and the access scope (which workspaces, languages, and categories its members can read)." }, "ReaderGroupCustomerV2CustomerApiResponse": { "type": "object", "properties": { "result": { "allOf": [ { "$ref": "#/components/schemas/ReaderGroupCustomerV2" } ], "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `true`.", "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, "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." }, "ReaderGroupCustomerV2ListCustomerApiResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/ReaderGroupCustomerV2" }, "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `true`.", "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, "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." }, "RedirectionMode": { "enum": [ "none", "redirectOnly", "redirectWithContent" ], "type": "string", "description": "Possible values: `\"none\"` = None, `\"redirectOnly\"` = RedirectOnly, `\"redirectWithContent\"` = RedirectWithContent", "x-enumNames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-enum-varnames": [ "None", "RedirectOnly", "RedirectWithContent" ], "x-ms-enum": { "name": "RedirectionMode", "modelAsString": true } }, "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 }, "ResponseLength": { "enum": [ "default", "longAndDetailed", "shortAndConcise" ], "type": "string", "description": "Possible values: `\"default\"` = Default, `\"longAndDetailed\"` = LongAndDetailed, `\"shortAndConcise\"` = ShortAndConcise", "x-enumNames": [ "Default", "LongAndDetailed", "ShortAndConcise" ], "x-enum-varnames": [ "Default", "LongAndDetailed", "ShortAndConcise" ], "x-ms-enum": { "name": "ResponseLength", "modelAsString": true } }, "ResponseTone": { "enum": [ "default", "professional", "friendly", "casual", "straightforward", "confident" ], "type": "string", "description": "Possible values: `\"default\"` = Default, `\"professional\"` = Professional, `\"friendly\"` = Friendly, `\"casual\"` = Casual, `\"straightforward\"` = Straightforward, `\"confident\"` = Confident", "x-enumNames": [ "Default", "Professional", "Friendly", "Casual", "Straightforward", "Confident" ], "x-enum-varnames": [ "Default", "Professional", "Friendly", "Casual", "Straightforward", "Confident" ], "x-ms-enum": { "name": "ResponseTone", "modelAsString": true } }, "RoleMetaData": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the role", "nullable": true, "readOnly": true }, "title": { "type": "string", "description": "Name of the role", "nullable": true }, "description": { "type": "string", "description": "Description of role", "nullable": true }, "is_system_role": { "type": "boolean", "description": "If true, it indicates that the role is one of the system default roles." }, "role_type": { "enum": [ "portalRole", "contentRole" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RoleType" } ], "description": "Indicates if the role is a portal role or a content role", "x-enumNames": [ "PortalRole", "ContentRole" ], "x-enum-varnames": [ "PortalRole", "ContentRole" ], "x-ms-enum": { "name": "RoleType", "modelAsString": true } } }, "additionalProperties": false }, "RoleMetaDataListCustomerApiResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/RoleMetaData" }, "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `true`.", "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, "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." }, "RoleSummaryCustomer": { "type": "object", "properties": { "role_id": { "type": "string", "nullable": true }, "role_name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RoleType": { "enum": [ "portalRole", "contentRole" ], "type": "string", "description": "Possible values: `\"portalRole\"` = PortalRole, `\"contentRole\"` = ContentRole", "x-enumNames": [ "PortalRole", "ContentRole" ], "x-enum-varnames": [ "PortalRole", "ContentRole" ], "x-ms-enum": { "name": "RoleType", "modelAsString": true } }, "SSOSchemeDetails": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "sso_name": { "type": "string", "nullable": true }, "project_id": { "type": "string", "nullable": true }, "scheme_name": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SSOSchemeReponse": { "type": "object", "properties": { "schemes": { "type": "array", "items": { "$ref": "#/components/schemas/SSOSchemeDetails" }, "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 }, "SSOUserTypes": { "enum": [ "normalUser", "ssoUser", "ssoUserInvited" ], "type": "string", "description": "SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user", "x-enumNames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-enum-varnames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-ms-enum": { "name": "SSOUserTypes", "modelAsString": true } }, "SearchProjectVersionResponseCustomerApi": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ArticleMatchedData" } ], "nullable": true }, "extension_data": { "allOf": [ { "$ref": "#/components/schemas/ExtensionDataObject" } ], "description": "Extention data for customer API response", "nullable": true }, "success": { "type": "boolean", "description": "Status indication for customer API response", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BaseError" }, "description": "Errors in the customer API response", "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/BaseWarning" }, "description": "Warnings in the customer API response", "nullable": true }, "information": { "type": "array", "items": { "$ref": "#/components/schemas/BaseInformation" }, "description": "Information passed by the customer API response", "nullable": true } }, "additionalProperties": false }, "SectionTypeEnum": { "enum": [ "all", "createKnowledgeBaseArticle", "inviteTeamMembers", "extensions", "homePageBuilder", "advanced" ], "type": "string", "description": "Possible values: `\"all\"` = All, `\"createKnowledgeBaseArticle\"` = CreateKnowledgeBaseArticle, `\"inviteTeamMembers\"` = InviteTeamMembers, `\"extensions\"` = Extensions, `\"homePageBuilder\"` = HomePageBuilder, `\"advanced\"` = Advanced", "x-enumNames": [ "All", "CreateKnowledgeBaseArticle", "InviteTeamMembers", "Extensions", "HomePageBuilder", "Advanced" ], "x-enum-varnames": [ "All", "CreateKnowledgeBaseArticle", "InviteTeamMembers", "Extensions", "HomePageBuilder", "Advanced" ], "x-ms-enum": { "name": "SectionTypeEnum", "modelAsString": true } }, "SecurityVisibility": { "enum": [ "public", "private" ], "type": "string", "description": "Protection level of an article or category. Controls whether the resource is publicly accessible or requires reader authentication.", "x-enumNames": [ "Public", "Private" ], "x-enum-varnames": [ "Public", "Private" ], "x-ms-enum": { "name": "SecurityVisibility", "modelAsString": true } }, "StaleStatus": { "type": "object", "properties": { "article_stale_status": { "enum": [ "fresh", "stale" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/ArticleStaleStatus" } ], "description": "The freshness classification of the article (Fresh, Stale, ReviewPending, etc.). Defaults to Fresh.", "x-enumNames": [ "Fresh", "Stale" ], "x-enum-varnames": [ "Fresh", "Stale" ], "x-ms-enum": { "name": "ArticleStaleStatus", "modelAsString": true } }, "stale_reason": { "type": "string", "description": "Free-text explanation captured when the article was marked stale.", "nullable": true }, "expired_at": { "type": "string", "description": "UTC date when this stale-status entry expires (article enters review).", "format": "date-time" }, "is_from_document_settings": { "type": "boolean", "description": "True if the stale policy was inherited from project-level documentation settings rather than set on the article directly." }, "expire_days": { "type": "integer", "description": "Number of days from publication after which the article should next be reviewed.", "format": "int32" } }, "additionalProperties": false, "description": "Freshness/review state for an article: whether it's still considered fresh, the\r\nreason it was marked stale, when the review window expires and how the policy was set." }, "StringCustomerApiResponse": { "type": "object", "properties": { "result": { "type": "string", "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `true`.", "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, "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." }, "TagsMetaDataCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The tag ID", "nullable": true, "readOnly": true }, "tag_name": { "type": "string", "description": "The tag name", "nullable": true } }, "additionalProperties": false }, "TeamAccountGroupSummaryCustomer": { "type": "object", "properties": { "group_id": { "type": "string", "description": "The ID of the team account group.", "nullable": true }, "title": { "type": "string", "description": "The name of the team account group.", "nullable": true }, "description": { "type": "string", "description": "Description of the team account group.", "nullable": true } }, "additionalProperties": false, "description": "Compact V2 team-account group descriptor — identity and description only. Returned by `GET /v2/teams/groups`." }, "TeamAccountGroupSummaryCustomerListCustomerApiResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/TeamAccountGroupSummaryCustomer" }, "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `true`.", "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, "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." }, "TeamAccountSummaryCustomer": { "type": "object", "properties": { "user_id": { "type": "string", "description": "The ID of the user", "nullable": true }, "first_name": { "type": "string", "description": "First name of the user", "nullable": true }, "last_name": { "type": "string", "description": "Last name of the user", "nullable": true }, "email_id": { "type": "string", "description": "Email address of the user", "nullable": true }, "profile_logo_url": { "type": "string", "description": "Profile image URL of the user", "nullable": true }, "portal_role": { "type": "string", "description": "The name of the portal role", "nullable": true }, "last_login_at": { "type": "string", "description": "Last login date of the user", "format": "date-time", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Compact V2 team account descriptor — identity, profile picture, portal role, and last-login timestamp. Returned by `GET /v2/teams`." }, "TeamAccountSummaryCustomerListCustomerApiResponse": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/TeamAccountSummaryCustomer" }, "description": "The operation's payload. Populated when Document360.Core.Messages.Core.CustomerApiBaseResponse.success is `true`.", "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, "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." }, "Title": { "type": "object", "properties": { "value": { "type": "string", "description": "Markup text with occurrences highlighted.", "nullable": true }, "match_level": { "type": "string", "description": "Indicates how well the attribute matched the search query. Can be: none, partial, full", "nullable": true }, "fully_highlighted": { "type": "boolean" }, "matched_words": { "type": "array", "items": { "type": "string" }, "description": "List of words from the query that matched the object.", "nullable": true } }, "additionalProperties": false }, "TrophyStatus": { "type": "object", "properties": { "first": { "type": "boolean" }, "second": { "type": "boolean" }, "third": { "type": "boolean" }, "fourth": { "type": "boolean" } }, "additionalProperties": false }, "UIElement": { "type": "object", "properties": { "element_type": { "enum": [ "homePageBody", "documentationPageBody", "navigationPageBody", "customPageBody", "heroSection", "customCodeSection", "imageWithTextSection", "multiColumnCardSection", "richTextSection", "widgetSection", "actionCardElement", "infoCardElement", "groupClickableElement", "clickableElement", "customHTMLInputElement", "customCSSInputElement", "imageElement", "headingTextElement", "inputTextboxElement", "textAreaElement", "topListWidgetElement", "imageWithFormSection", "formElement", "navigationElement", "containerSection", "articleHeaderElement", "articleContentElement", "treeElement", "feedbackElement", "commentsElement", "articleSummary", "multiColumnCardEditableSection", "multiColumnCardSectionV2", "tabSection", "tabItemElement", "widgetCardElement", "acknowledgementInfoElement", "acknowledgementSubmitElement", "guideNodeElement", "guideTextAreaElement", "guideHeadingTextElement", "guideGroupClickableElement", "guideImageElement", "guideButtonElement", "guideRadioButtonElement", "guideCheckboxElement", "guideDropdownElement" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/UIElementType" } ], "description": "Possible values: `\"homePageBody\"` = HomePageBody, `\"documentationPageBody\"` = DocumentationPageBody, `\"navigationPageBody\"` = NavigationPageBody, `\"customPageBody\"` = CustomPageBody, `\"heroSection\"` = HeroSection, `\"customCodeSection\"` = CustomCodeSection, `\"imageWithTextSection\"` = ImageWithTextSection, `\"multiColumnCardSection\"` = MultiColumnCardSection, `\"richTextSection\"` = RichTextSection, `\"widgetSection\"` = WidgetSection, `\"actionCardElement\"` = ActionCardElement, `\"infoCardElement\"` = InfoCardElement, `\"groupClickableElement\"` = GroupClickableElement, `\"clickableElement\"` = ClickableElement, `\"customHTMLInputElement\"` = CustomHTMLInputElement, `\"customCSSInputElement\"` = CustomCSSInputElement, `\"imageElement\"` = ImageElement, `\"headingTextElement\"` = HeadingTextElement, `\"inputTextboxElement\"` = InputTextboxElement, `\"textAreaElement\"` = TextAreaElement, `\"topListWidgetElement\"` = TopListWidgetElement, `\"imageWithFormSection\"` = ImageWithFormSection, `\"formElement\"` = FormElement, `\"navigationElement\"` = NavigationElement, `\"containerSection\"` = ContainerSection, `\"articleHeaderElement\"` = ArticleHeaderElement, `\"articleContentElement\"` = ArticleContentElement, `\"treeElement\"` = TreeElement, `\"feedbackElement\"` = FeedbackElement, `\"commentsElement\"` = CommentsElement, `\"articleSummary\"` = ArticleSummary, `\"multiColumnCardEditableSection\"` = MultiColumnCardEditableSection, `\"multiColumnCardSectionV2\"` = MultiColumnCardSectionV2, `\"tabSection\"` = TabSection, `\"tabItemElement\"` = TabItemElement, `\"widgetCardElement\"` = WidgetCardElement, `\"acknowledgementInfoElement\"` = AcknowledgementInfoElement, `\"acknowledgementSubmitElement\"` = AcknowledgementSubmitElement, `\"guideNodeElement\"` = GuideNodeElement, `\"guideTextAreaElement\"` = GuideTextAreaElement, `\"guideHeadingTextElement\"` = GuideHeadingTextElement, `\"guideGroupClickableElement\"` = GuideGroupClickableElement, `\"guideImageElement\"` = GuideImageElement, `\"guideButtonElement\"` = GuideButtonElement, `\"guideRadioButtonElement\"` = GuideRadioButtonElement, `\"guideCheckboxElement\"` = GuideCheckboxElement, `\"guideDropdownElement\"` = GuideDropdownElement", "x-enumNames": [ "HomePageBody", "DocumentationPageBody", "NavigationPageBody", "CustomPageBody", "HeroSection", "CustomCodeSection", "ImageWithTextSection", "MultiColumnCardSection", "RichTextSection", "WidgetSection", "ActionCardElement", "InfoCardElement", "GroupClickableElement", "ClickableElement", "CustomHTMLInputElement", "CustomCSSInputElement", "ImageElement", "HeadingTextElement", "InputTextboxElement", "TextAreaElement", "TopListWidgetElement", "ImageWithFormSection", "FormElement", "NavigationElement", "ContainerSection", "ArticleHeaderElement", "ArticleContentElement", "TreeElement", "FeedbackElement", "CommentsElement", "ArticleSummary", "MultiColumnCardEditableSection", "MultiColumnCardSectionV2", "TabSection", "TabItemElement", "WidgetCardElement", "AcknowledgementInfoElement", "AcknowledgementSubmitElement", "GuideNodeElement", "GuideTextAreaElement", "GuideHeadingTextElement", "GuideGroupClickableElement", "GuideImageElement", "GuideButtonElement", "GuideRadioButtonElement", "GuideCheckboxElement", "GuideDropdownElement" ], "x-enum-varnames": [ "HomePageBody", "DocumentationPageBody", "NavigationPageBody", "CustomPageBody", "HeroSection", "CustomCodeSection", "ImageWithTextSection", "MultiColumnCardSection", "RichTextSection", "WidgetSection", "ActionCardElement", "InfoCardElement", "GroupClickableElement", "ClickableElement", "CustomHTMLInputElement", "CustomCSSInputElement", "ImageElement", "HeadingTextElement", "InputTextboxElement", "TextAreaElement", "TopListWidgetElement", "ImageWithFormSection", "FormElement", "NavigationElement", "ContainerSection", "ArticleHeaderElement", "ArticleContentElement", "TreeElement", "FeedbackElement", "CommentsElement", "ArticleSummary", "MultiColumnCardEditableSection", "MultiColumnCardSectionV2", "TabSection", "TabItemElement", "WidgetCardElement", "AcknowledgementInfoElement", "AcknowledgementSubmitElement", "GuideNodeElement", "GuideTextAreaElement", "GuideHeadingTextElement", "GuideGroupClickableElement", "GuideImageElement", "GuideButtonElement", "GuideRadioButtonElement", "GuideCheckboxElement", "GuideDropdownElement" ], "x-ms-enum": { "name": "UIElementType", "modelAsString": true } }, "element_name": { "type": "string", "nullable": true }, "element_guid": { "type": "string", "nullable": true }, "display_name": { "type": "string", "nullable": true }, "view_styles": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "view_properties": { "type": "object", "additionalProperties": { "nullable": true }, "nullable": true }, "editable_properties": { "type": "array", "items": { "$ref": "#/components/schemas/FormEditableProperties" }, "nullable": true }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/UIElement" }, "nullable": true } }, "additionalProperties": false }, "UIElementType": { "enum": [ "homePageBody", "documentationPageBody", "navigationPageBody", "customPageBody", "heroSection", "customCodeSection", "imageWithTextSection", "multiColumnCardSection", "richTextSection", "widgetSection", "actionCardElement", "infoCardElement", "groupClickableElement", "clickableElement", "customHTMLInputElement", "customCSSInputElement", "imageElement", "headingTextElement", "inputTextboxElement", "textAreaElement", "topListWidgetElement", "imageWithFormSection", "formElement", "navigationElement", "containerSection", "articleHeaderElement", "articleContentElement", "treeElement", "feedbackElement", "commentsElement", "articleSummary", "multiColumnCardEditableSection", "multiColumnCardSectionV2", "tabSection", "tabItemElement", "widgetCardElement", "acknowledgementInfoElement", "acknowledgementSubmitElement", "guideNodeElement", "guideTextAreaElement", "guideHeadingTextElement", "guideGroupClickableElement", "guideImageElement", "guideButtonElement", "guideRadioButtonElement", "guideCheckboxElement", "guideDropdownElement" ], "type": "string", "description": "Possible values: `\"homePageBody\"` = HomePageBody, `\"documentationPageBody\"` = DocumentationPageBody, `\"navigationPageBody\"` = NavigationPageBody, `\"customPageBody\"` = CustomPageBody, `\"heroSection\"` = HeroSection, `\"customCodeSection\"` = CustomCodeSection, `\"imageWithTextSection\"` = ImageWithTextSection, `\"multiColumnCardSection\"` = MultiColumnCardSection, `\"richTextSection\"` = RichTextSection, `\"widgetSection\"` = WidgetSection, `\"actionCardElement\"` = ActionCardElement, `\"infoCardElement\"` = InfoCardElement, `\"groupClickableElement\"` = GroupClickableElement, `\"clickableElement\"` = ClickableElement, `\"customHTMLInputElement\"` = CustomHTMLInputElement, `\"customCSSInputElement\"` = CustomCSSInputElement, `\"imageElement\"` = ImageElement, `\"headingTextElement\"` = HeadingTextElement, `\"inputTextboxElement\"` = InputTextboxElement, `\"textAreaElement\"` = TextAreaElement, `\"topListWidgetElement\"` = TopListWidgetElement, `\"imageWithFormSection\"` = ImageWithFormSection, `\"formElement\"` = FormElement, `\"navigationElement\"` = NavigationElement, `\"containerSection\"` = ContainerSection, `\"articleHeaderElement\"` = ArticleHeaderElement, `\"articleContentElement\"` = ArticleContentElement, `\"treeElement\"` = TreeElement, `\"feedbackElement\"` = FeedbackElement, `\"commentsElement\"` = CommentsElement, `\"articleSummary\"` = ArticleSummary, `\"multiColumnCardEditableSection\"` = MultiColumnCardEditableSection, `\"multiColumnCardSectionV2\"` = MultiColumnCardSectionV2, `\"tabSection\"` = TabSection, `\"tabItemElement\"` = TabItemElement, `\"widgetCardElement\"` = WidgetCardElement, `\"acknowledgementInfoElement\"` = AcknowledgementInfoElement, `\"acknowledgementSubmitElement\"` = AcknowledgementSubmitElement, `\"guideNodeElement\"` = GuideNodeElement, `\"guideTextAreaElement\"` = GuideTextAreaElement, `\"guideHeadingTextElement\"` = GuideHeadingTextElement, `\"guideGroupClickableElement\"` = GuideGroupClickableElement, `\"guideImageElement\"` = GuideImageElement, `\"guideButtonElement\"` = GuideButtonElement, `\"guideRadioButtonElement\"` = GuideRadioButtonElement, `\"guideCheckboxElement\"` = GuideCheckboxElement, `\"guideDropdownElement\"` = GuideDropdownElement", "x-enumNames": [ "HomePageBody", "DocumentationPageBody", "NavigationPageBody", "CustomPageBody", "HeroSection", "CustomCodeSection", "ImageWithTextSection", "MultiColumnCardSection", "RichTextSection", "WidgetSection", "ActionCardElement", "InfoCardElement", "GroupClickableElement", "ClickableElement", "CustomHTMLInputElement", "CustomCSSInputElement", "ImageElement", "HeadingTextElement", "InputTextboxElement", "TextAreaElement", "TopListWidgetElement", "ImageWithFormSection", "FormElement", "NavigationElement", "ContainerSection", "ArticleHeaderElement", "ArticleContentElement", "TreeElement", "FeedbackElement", "CommentsElement", "ArticleSummary", "MultiColumnCardEditableSection", "MultiColumnCardSectionV2", "TabSection", "TabItemElement", "WidgetCardElement", "AcknowledgementInfoElement", "AcknowledgementSubmitElement", "GuideNodeElement", "GuideTextAreaElement", "GuideHeadingTextElement", "GuideGroupClickableElement", "GuideImageElement", "GuideButtonElement", "GuideRadioButtonElement", "GuideCheckboxElement", "GuideDropdownElement" ], "x-enum-varnames": [ "HomePageBody", "DocumentationPageBody", "NavigationPageBody", "CustomPageBody", "HeroSection", "CustomCodeSection", "ImageWithTextSection", "MultiColumnCardSection", "RichTextSection", "WidgetSection", "ActionCardElement", "InfoCardElement", "GroupClickableElement", "ClickableElement", "CustomHTMLInputElement", "CustomCSSInputElement", "ImageElement", "HeadingTextElement", "InputTextboxElement", "TextAreaElement", "TopListWidgetElement", "ImageWithFormSection", "FormElement", "NavigationElement", "ContainerSection", "ArticleHeaderElement", "ArticleContentElement", "TreeElement", "FeedbackElement", "CommentsElement", "ArticleSummary", "MultiColumnCardEditableSection", "MultiColumnCardSectionV2", "TabSection", "TabItemElement", "WidgetCardElement", "AcknowledgementInfoElement", "AcknowledgementSubmitElement", "GuideNodeElement", "GuideTextAreaElement", "GuideHeadingTextElement", "GuideGroupClickableElement", "GuideImageElement", "GuideButtonElement", "GuideRadioButtonElement", "GuideCheckboxElement", "GuideDropdownElement" ], "x-ms-enum": { "name": "UIElementType", "modelAsString": true } }, "UnpublishArticleRequest": { "required": [ "project_version_id", "user_id", "version_number" ], "type": "object", "properties": { "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account that will be marked as the contributor of this unpublish" }, "project_version_id": { "minLength": 1, "type": "string", "description": "The project version ID where the article exists." }, "version_number": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The version number of the article to be unpublished", "format": "int32" }, "unpublish_message": { "type": "string", "description": "The unpublish message of the article", "nullable": true } }, "additionalProperties": false }, "UnpublishCategoryRequest": { "required": [ "project_version_id", "user_id", "version_number" ], "type": "object", "properties": { "user_id": { "minLength": 1, "type": "string", "description": "The ID of the team account who is responsible for the unpublish" }, "project_version_id": { "minLength": 1, "type": "string", "description": "The project version ID where the article exists." }, "version_number": { "maximum": 32767, "minimum": 1, "type": "integer", "description": "The version number of the category", "format": "int32" }, "unpublish_message": { "type": "string", "description": "Unublish message for the category", "nullable": true } }, "additionalProperties": false }, "UpdateArticleRequest": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the article", "nullable": true }, "content": { "type": "string", "description": "The content of the article, for any Editor type, use this property.", "nullable": true }, "html_content": { "type": "string", "description": "The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use **content** property instead of this.)", "nullable": true, "deprecated": true }, "category_id": { "type": "string", "description": "The ID of the category. If the article has to be moved to another category, enter the desired category ID", "nullable": true }, "hidden": { "type": "boolean", "description": "Visibility status of the article. **true** - Article will be hidden; **false** - Article will be shown" }, "version_number": { "type": "integer", "description": "The version number of the article to be updated. The latest version is updated by default.", "format": "int32", "nullable": true }, "translation_option": { "type": "string", "description": "Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated", "nullable": true }, "source": { "type": "string", "description": "Free text used for future reference", "nullable": true }, "order": { "type": "integer", "description": "To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).", "format": "int32" }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The format of `content`, for articles written in Editor 3.0 (which are always stored as Advanced\r\nWYSIWYG): 2 (Block, the default when omitted) - `content` is the article HTML; 0 (Markdown) -\r\n`content` is DFM markdown, the format GET returns in `content`, so a GET-then-update round\r\ntrip sends it back with 0. 1 (WYSIWYG) is rejected. Ignored for every other article, which keeps its\r\nstored format.", "nullable": true } }, "additionalProperties": false }, "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 }, "UpdateArticleSettingsResponseCustomer": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ArticleSettingCustomerResponse" } ], "description": "update article settings", "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 }, "UpdateCategoryContentCustomerRequest": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the category", "nullable": true }, "content": { "type": "string", "description": "The content of the category, for any Editor type, use this property.", "nullable": true }, "html_content": { "type": "string", "description": "The HTML content of the category. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use **content** property instead of this.)", "nullable": true, "deprecated": true }, "block_content": { "type": "string", "description": "The HTML content of the category. If the editor type is Block Editor (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use **content** property instead of this.)", "nullable": true, "deprecated": true }, "version_number": { "type": "integer", "description": "The version number of the category to be updated. The latest version is updated by default.", "format": "int32", "nullable": true }, "translation_option": { "type": "string", "description": "Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated", "nullable": true }, "source": { "type": "string", "description": "Free text used for future reference", "nullable": true }, "updated_by": { "type": "string", "description": "The ID of the team account responsible for the category update", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The format of `content`, for page categories written in Editor 3.0 (which are always stored as\r\nAdvanced WYSIWYG): 2 (Block, the default when omitted) - `content` is the page HTML; 0 (Markdown) -\r\n`content` is DFM markdown, the format GET returns in `content`. 1 (WYSIWYG) is rejected.\r\nIgnored for every other category, which keeps its stored format.", "nullable": true } }, "additionalProperties": false }, "UpdateCategoryContentCustomerResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CategoryVersionDataCustomer" } ], "description": "category version 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 }, "UpdateCategoryContentRequest": { "type": "object", "properties": { "category_id": { "type": "string", "description": "Category ID for updating the content", "nullable": true }, "lang_code": { "type": "string", "description": "Language Code for updating the content", "nullable": true }, "title": { "type": "string", "description": "The title of the category", "nullable": true }, "content": { "type": "string", "description": "The content of the category, for any Editor type, use this property.", "nullable": true }, "html_content": { "type": "string", "description": "The HTML content of the category. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use **content** property instead of this.)", "nullable": true, "deprecated": true }, "block_content": { "type": "string", "description": "The HTML content of the category. If the editor type is Block Editor (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use **content** property instead of this.)", "nullable": true, "deprecated": true }, "version_number": { "type": "integer", "description": "The version number of the category to be updated. The latest version is updated by default.", "format": "int32", "nullable": true }, "translation_option": { "type": "string", "description": "Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated", "nullable": true }, "source": { "type": "string", "description": "Free text used for future reference", "nullable": true }, "updated_by": { "type": "string", "description": "The ID of the team account responsible for the category update", "nullable": true }, "content_type": { "allOf": [ { "$ref": "#/components/schemas/ArticleContentType" } ], "description": "The format of `content`, for page categories written in Editor 3.0 (which are always stored as\r\nAdvanced WYSIWYG): 2 (Block, the default when omitted) - `content` is the page HTML; 0 (Markdown) -\r\n`content` is DFM markdown, the format GET returns in `content`. 1 (WYSIWYG) is rejected.\r\nIgnored for every other category, which keeps its stored format.", "nullable": true } }, "additionalProperties": false, "description": "Update category content" }, "UpdateCategoryRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the category", "nullable": true }, "order": { "type": "integer", "description": "The position of the category. By default, it will be added at the end of the parent category.", "format": "int32" }, "parent_category_id": { "type": "string", "description": "The ID of the category where the category will be moved. By default, it will be created at the first level.", "nullable": true }, "hidden": { "type": "boolean", "description": "Visibility status of the category. **true** - Category will be hidden; **false** - Category will be shown" }, "icon": { "type": "string", "description": "The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)", "nullable": true }, "language": { "type": "string", "description": "Language code of the category. If language is not specified, the category would be updated in the default language.", "nullable": true } }, "additionalProperties": false }, "UpdateCategoryResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CategorySimpleData" } ], "description": "category simple 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 }, "UpdateCategoryWorkflowStatusRequest": { "required": [ "category_ids", "lang_code", "project_version_id", "user_id", "workflow_status_info" ], "type": "object", "properties": { "project_version_id": { "minLength": 1, "type": "string", "description": "Identifier of the specific workspace in the project in which the articles exist. This ID is used to ensure the workflow status update is applied to articles in a particular workspace." }, "lang_code": { "minLength": 1, "type": "string", "description": "Language code of the articles whose workflow status is being updated (e.g., \"en\", \"fr\"). This ensures the workflow status update is applied to the article in the specified language." }, "user_id": { "minLength": 1, "type": "string", "description": "User ID of the team account changing the workflow status. This team account will be recorded in the audit log." }, "category_ids": { "type": "array", "items": { "type": "string" }, "description": "List of category IDs to be updated. Each ID in this array should refer to an existing article in the specified project version and language." }, "workflow_status_info": { "allOf": [ { "$ref": "#/components/schemas/CategoryWorkflowStatus" } ], "description": "Object for workflow status metadata. This object defines the new workflow status and any associated information like due date, comment, or assignee." } }, "additionalProperties": false }, "UpdateMediaFolderRequestCustomer": { "type": "object", "properties": { "name": { "type": "string", "description": "The new name for the folder being updated", "nullable": true }, "order": { "type": "integer", "description": "The order of the folder", "format": "int32", "nullable": true }, "folder_color": { "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": "string", "description": "The color of the folder - should be in hexadecimal color code format", "nullable": true }, "is_starred": { "type": "boolean", "description": "To update the folder as starred" } }, "additionalProperties": false }, "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 }, "UpdateReaderRequestV2": { "required": [ "access_scope", "associated_reader_groups" ], "type": "object", "properties": { "first_name": { "type": "string", "description": "The first name of the reader", "nullable": true }, "last_name": { "type": "string", "description": "The last name of the reader", "nullable": true }, "associated_reader_groups": { "type": "array", "items": { "type": "string" }, "description": "List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups." }, "access_scope": { "allOf": [ { "$ref": "#/components/schemas/AddUpdateAccessScopeCustomerV2" } ], "description": "Access level of the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language." }, "is_invitation_id": { "type": "boolean", "description": "Applicable only for Single Sign-On readers. Set this property to true, if the reader is a Single Sign-On reader who hasn't logged in to the application yet." }, "sso_user_type": { "enum": [ "normalUser", "ssoUser", "ssoUserInvited" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SSOUserTypes" } ], "description": "SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user", "x-enumNames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-enum-varnames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-ms-enum": { "name": "SSOUserTypes", "modelAsString": true } } }, "additionalProperties": false }, "UserAccess": { "enum": [ "administrator", "editor", "draftWriter", "reader", "owner" ], "type": "string", "description": "Predefined access role for a project user. Used in the V1 Customer API to assign or filter users by role. Newer integrations should prefer the role IDs exposed by `GET /v2/teams/roles`.", "x-enumNames": [ "Administrator", "Editor", "DraftWriter", "Reader", "Owner" ], "x-enum-varnames": [ "Administrator", "Editor", "DraftWriter", "Reader", "Owner" ], "x-ms-enum": { "name": "UserAccess", "modelAsString": true } }, "UserDetailsCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the team account.", "nullable": true, "readOnly": true }, "first_name": { "type": "string", "description": "First name of the team account.", "nullable": true }, "last_name": { "type": "string", "description": "Last name of the team account.", "nullable": true }, "user_description": { "type": "string", "description": "Free-text description shown on the user's profile.", "nullable": true }, "unique_user_name": { "type": "string", "description": "The unique display name (handle) for the team account.", "nullable": true }, "email_id": { "type": "string", "description": "Email address of the team account.", "nullable": true }, "profile_logo_url": { "type": "string", "description": "URL of the user's profile picture (served via blob storage; a SAS token is appended for private/mixed projects).", "nullable": true }, "profile_logo_cdn_url": { "type": "string", "description": "CDN-fronted URL for the user's profile picture (with SAS token appended for private/mixed projects).", "nullable": true }, "is_enterprise_user": { "type": "boolean", "description": "`True` when the team account was provisioned via an enterprise SSO connection." } }, "additionalProperties": false, "description": "Compact representation of a team account — surfaced as an author/contributor on articles and categories." }, "UserProfileCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the team account.", "nullable": true, "readOnly": true }, "first_name": { "type": "string", "description": "First name.", "nullable": true }, "last_name": { "type": "string", "description": "Last name.", "nullable": true }, "email_id": { "type": "string", "description": "Email address.", "nullable": true }, "profile_logo_url": { "type": "string", "description": "URL of the user's profile picture (with SAS token appended for private/mixed projects).", "nullable": true }, "user_role": { "enum": [ "administrator", "editor", "draftWriter", "reader", "owner" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/UserAccess" } ], "description": "The user's V1 role. See Document360.Core.Enums.UserAccess for the available values.", "x-enumNames": [ "Administrator", "Editor", "DraftWriter", "Reader", "Owner" ], "x-enum-varnames": [ "Administrator", "Editor", "DraftWriter", "Reader", "Owner" ], "x-ms-enum": { "name": "UserAccess", "modelAsString": true } }, "last_login_at": { "type": "string", "description": "Timestamp of the most recent successful sign-in. `null` if the user has never signed in.", "format": "date-time", "nullable": true, "readOnly": true }, "unique_user_name": { "type": "string", "description": "The unique display name (handle) for the user.", "nullable": true }, "sso_user_type": { "enum": [ "normalUser", "ssoUser", "ssoUserInvited" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SSOUserTypes" } ], "description": "For SSO users, indicates the SSO provisioning state (e.g. invited, active).", "x-enumNames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-enum-varnames": [ "NormalUser", "SSOUser", "SSOUserInvited" ], "x-ms-enum": { "name": "SSOUserTypes", "modelAsString": true } }, "is_sso_user": { "type": "boolean", "description": "`True` when the user was provisioned via SSO." }, "is_active": { "type": "boolean", "description": "`True` when the user is active (not deactivated or pending invitation)." } }, "additionalProperties": false, "description": "V1 team account profile — identity, contact details, role, login state, and SSO flags. Returned by `GET /v1/teams` and `GET /v1/teams/{userId}`." }, "VectorSearchReferenceArticles": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "readOnly": true }, "citation_id": { "type": "string", "nullable": true }, "category_id": { "type": "string", "nullable": true }, "category_title": { "type": "string", "nullable": true }, "category_slug": { "type": "string", "nullable": true }, "version_name": { "type": "string", "nullable": true }, "version_slug": { "type": "string", "nullable": true }, "article_id": { "type": "string", "nullable": true }, "article_title": { "type": "string", "nullable": true }, "article_slug": { "type": "string", "nullable": true }, "version_display_name": { "type": "string", "nullable": true }, "language_code": { "type": "string", "nullable": true }, "data_source_type": { "enum": [ "internalKBArticle", "externalSource" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/DataSourceType" } ], "description": "Possible values: `\"internalKBArticle\"` = InternalKBArticle, `\"externalSource\"` = ExternalSource", "x-enumNames": [ "InternalKBArticle", "ExternalSource" ], "x-enum-varnames": [ "InternalKBArticle", "ExternalSource" ], "x-ms-enum": { "name": "DataSourceType", "modelAsString": true } }, "external_source_link": { "type": "string", "nullable": true }, "external_source_name": { "type": "string", "nullable": true }, "external_source_id": { "type": "string", "nullable": true }, "external_source_record_id": { "type": "string", "description": "The parent source record; see Document360.Core.Models.AI.KnnVectorSearchResult.ExternalSourceRecordId.", "nullable": true }, "external_source_type": { "allOf": [ { "$ref": "#/components/schemas/ExternalSourceType" } ], "nullable": true }, "is_attachment": { "type": "boolean" }, "attachment_url": { "type": "string", "nullable": true }, "attachment_title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VersionAccessInfo": { "type": "object", "properties": { "version_name": { "type": "string", "nullable": true }, "version_id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ViewFormControl": { "type": "object", "properties": { "property_key": { "type": "string", "nullable": true }, "is_children": { "type": "integer", "format": "int32" }, "view_type": { "type": "string", "nullable": true }, "element_name": { "type": "string", "nullable": true }, "is_children_root": { "type": "boolean" }, "element_type": { "type": "string", "nullable": true }, "inverted_value": { "type": "boolean" }, "is_dirty": { "type": "boolean" } }, "additionalProperties": false }, "WorkflowStatusCustomer": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the workflow status. This ID is used while updating the workflow status for articles and page categories using the Update workflow status of articles and Update workflow status of page categories endpoints respectively.", "nullable": true, "readOnly": true }, "name": { "type": "string", "description": "Display name of the workflow status (e.g., \"Draft\", \"In Review\"). The workflow status is displayed to all team accounts working on the article.", "nullable": true }, "description": { "type": "string", "description": "Optional explanation of the status. Used to clarify the intent or usage of the status in the workflow. May be blank if no description was provided during setup.", "nullable": true }, "read_only": { "type": "boolean", "description": "Indicates whether read-only mode is toggled on for the workflow status. \n
\r\n• true: workflow status is set to read-only.No edits can be made to the article.No comments can be added to the article. \n
\r\n• false: Contributors can edit the article and add comments to the article to provide feedback." }, "make_comment_mandatory": { "type": "boolean", "description": "Indicates whether a comment is required when moving an article or page category to this workflow status." } }, "additionalProperties": false }, "_Highlightresult": { "type": "object", "properties": { "title": { "allOf": [ { "$ref": "#/components/schemas/Title" } ], "nullable": true } }, "additionalProperties": false }, "_Snippetresult": { "type": "object", "properties": { "content": { "allOf": [ { "$ref": "#/components/schemas/Content" } ], "nullable": true } }, "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" } } }, "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" ] } ] }