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.
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.
[
{
"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"
}
]Update category content
Category ID for updating the content
Language Code for updating the content
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
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.
[
{
"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"
}
]Update category content
Category ID for updating the content
Language Code for updating the content
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
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.
[
{
"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"
}
]Update category content
Category ID for updating the content
Language Code for updating the content
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
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.
[
{
"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"
}
]Update category content
Category ID for updating the content
Language Code for updating the content
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
Success
You can find all the updated Category page details below.
{
"data": [
{
"category_id": "152e9239-1a5a-4044-b5de-1030f49976b6",
"success": true,
"details": "Successfully updated category with an id 152e9239-1a5a-4044-b5de-1030f49976b6"
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Bulk Updating of category content
The ID of the category
True - Category is published
False - Category is not published
Description of the action performed
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.
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.
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.
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.
Bad Request
The enhtered categoryId is not valid. Kindly verify the categoryId and perform the task again.
{
"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": []
}The user_id is not found. kindly verify the updated_by (user id) from /V2/Teams Get Method
{
"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": []
}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.
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.
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.
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.