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.
ID of the category
Fork category page with current version_number, user_id and lang_code.
{
"version_number": 1,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"lang_code": "en"
}The version number of the category page
The ID of the team account
Language code of the category
Fork category page with current version_number, user_id and lang_code.
{
"version_number": 1,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"lang_code": "en"
}The version number of the category page
The ID of the team account
Language code of the category
Fork category page with current version_number, user_id and lang_code.
{
"version_number": 1,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"lang_code": "en"
}The version number of the category page
The ID of the team account
Language code of the category
Fork category page with current version_number, user_id and lang_code.
{
"version_number": 1,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"lang_code": "en"
}The version number of the category page
The ID of the team account
Language code of the category
Success
Fork category page with current version_number, user_id and lang_code.
{
"data": {
"version_number": 2,
"created_by": "peter jone",
"created_at": "2024-06-13T14:30:00Z",
"modified_at": "2024-06-13T14:30:00Z",
"base_version": 1,
"status": 0,
"profile_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}category response forked data
The currently fetched version number of this category page
The ID of the user that created the category page
The date the category page was created
The date the category page was last modified
The base version of the currently fetched category page
The status of the article: 0 - Draft, 3 - Published
The URL of team account's profile image
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
Category page not found in the context. Kindly verify the categoryId and perform the task again.
{
"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 in the context. Kindly verify the categoryId and perform the task again.
{
"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 in the context. Kindly verify the categoryId and perform the task again.
{
"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 is missing in the Request Body. Kindly verify the categoryId and perform the task again.
{
"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": []
}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.