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
Request for Updating Category Name.\n if you are not using parent_category_id then remove the field.
{
"name": "UpdatedName",
"order": 0,
"parent_category_id": "814bd3cc-4cd1-4f97-adde-d4d644e9fe78",
"hidden": false,
"icon": "",
"language": "en"
}The name of the category
The position of the category. By default, it will be added at the end of the parent category.
The ID of the category where the category will be moved. By default, it will be created at the first level.
Visibility status of the category. true - Category will be hidden; false - Category will be shown
The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)
Language code of the category. If language is not specified, the category would be updated in the default language.
Request for Updating Category Name.\n if you are not using parent_category_id then remove the field.
{
"name": "UpdatedName",
"order": 0,
"parent_category_id": "814bd3cc-4cd1-4f97-adde-d4d644e9fe78",
"hidden": false,
"icon": "",
"language": "en"
}The name of the category
The position of the category. By default, it will be added at the end of the parent category.
The ID of the category where the category will be moved. By default, it will be created at the first level.
Visibility status of the category. true - Category will be hidden; false - Category will be shown
The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)
Language code of the category. If language is not specified, the category would be updated in the default language.
Request for Updating Category Name.\n if you are not using parent_category_id then remove the field.
{
"name": "UpdatedName",
"order": 0,
"parent_category_id": "814bd3cc-4cd1-4f97-adde-d4d644e9fe78",
"hidden": false,
"icon": "",
"language": "en"
}The name of the category
The position of the category. By default, it will be added at the end of the parent category.
The ID of the category where the category will be moved. By default, it will be created at the first level.
Visibility status of the category. true - Category will be hidden; false - Category will be shown
The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)
Language code of the category. If language is not specified, the category would be updated in the default language.
Request for Updating Category Name.\n if you are not using parent_category_id then remove the field.
{
"name": "UpdatedName",
"order": 0,
"parent_category_id": "814bd3cc-4cd1-4f97-adde-d4d644e9fe78",
"hidden": false,
"icon": "",
"language": "en"
}The name of the category
The position of the category. By default, it will be added at the end of the parent category.
The ID of the category where the category will be moved. By default, it will be created at the first level.
Visibility status of the category. true - Category will be hidden; false - Category will be shown
The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)
Language code of the category. If language is not specified, the category would be updated in the default language.
Success
Updated Catgory information is shown in this response.
{
"data": {
"id": "68212cec-7a9b-4323-9bb8-33865444a508",
"name": "UpdatedName",
"order": 0,
"icon": ""
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}category simple data
The ID of the category
Name of the category
The position inside the parent category
Unicode representation of the icon
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
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": []
}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.
{
"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": []
}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.