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.
The ID of the category. Fetch via GET /v2/projectversions/{projectVersionId}/categories.
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.
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.
Updated Catgory information is shown in this response.
{
"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"
}The title of the category
The content of the category, for any Editor type, use this property.
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.)
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.)
The version number of the category to be updated. The latest version is updated by default.
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
The ID of the team account responsible for the category update
Updated Catgory information is shown in this response.
{
"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"
}The title of the category
The content of the category, for any Editor type, use this property.
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.)
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.)
The version number of the category to be updated. The latest version is updated by default.
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
The ID of the team account responsible for the category update
Updated Catgory information is shown in this response.
{
"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"
}The title of the category
The content of the category, for any Editor type, use this property.
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.)
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.)
The version number of the category to be updated. The latest version is updated by default.
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
The ID of the team account responsible for the category update
Updated Catgory information is shown in this response.
{
"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"
}The title of the category
The content of the category, for any Editor type, use this property.
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.)
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.)
The version number of the category to be updated. The latest version is updated by default.
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
The ID of the team account responsible for the category update
Operation succeeded. Inspect the response envelope's success flag and the result/data payload.
Updated Catgory information is shown in this response.
{
"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,
"order": 0,
"created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"authors": [],
"created_at": "2024-06-13T14:30:00Z",
"modified_at": "2024-06-13T14:30:00Z",
"slug": "updatetitleforcategorypage",
"is_fall_back_content": false
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}category version data
The ID of the category
The title of the category
The content of the category
The HTML content of the category
The HTML content of the category (Block editor)
Existing category ID
Existing project version ID
Category Version Number
The ID of the project version where this category is located
The latest version number of this category
Indicates if Right to Left alignment is enabled for the category language
Indicates if the category is visible on the site
The status of the category: 0 - Draft, 3 - Published
The position inside the parent category
The ID of the user that created the category
The list of authors that contributed to this category
V1 team account profile — identity, contact details, role, login state, and SSO flags. Returned by GET /v1/teams and GET /v1/teams/{userId}.
The ID of the team account.
First name.
Last name.
Email address.
URL of the user's profile picture (with SAS token appended for private/mixed projects).
The user's V1 role. See Document360.Core.Enums.UserAccess for the available values.
Timestamp of the most recent successful sign-in. null if the user has never signed in.
The unique display name (handle) for the user.
For SSO users, indicates the SSO provisioning state (e.g. invited, active).
True when the user was provisioned via SSO.
True when the user is active (not deactivated or pending invitation).
The date the category was created
The date the category was last modified
The slug of the category
Indicates whether the category content is a fallback of the default language content or not
Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
The request body or query parameters failed validation. Inspect errors[].description for the offending fields.
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"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": []
}Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Authentication failed — the api_token header is missing, malformed, or has been revoked.
Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
The requested resource was not found, or the supplied identifier does not exist in the project.
Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Rate limit exceeded for this api_token. Wait for the duration in the Retry-After header before retrying.
Extension data for customer API response
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.
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.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.