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.
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.
[
{
"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
},
{
"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
}
]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.
[
{
"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
},
{
"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
}
]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.
[
{
"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
},
{
"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
}
]The name of the category
The ID of the project version where category has to be added
The position inside the parent category
The ID of the parent category. If empty, it will be added as top level category)
The content of the article, for any Editor type, use this property
0 - Folder, 1 - Page, 2 - Index
The ID of the team account
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
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.
[
{
"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
},
{
"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
}
]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.
[
{
"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
},
{
"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
}
]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.
[
{
"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
},
{
"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
}
]The name of the category
The ID of the project version where category has to be added
The position inside the parent category
The ID of the parent category. If empty, it will be added as top level category)
The content of the article, for any Editor type, use this property
0 - Folder, 1 - Page, 2 - Index
The ID of the team account
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
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.
[
{
"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
},
{
"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
}
]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.
[
{
"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
},
{
"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
}
]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.
[
{
"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
},
{
"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
}
]The name of the category
The ID of the project version where category has to be added
The position inside the parent category
The ID of the parent category. If empty, it will be added as top level category)
The content of the article, for any Editor type, use this property
0 - Folder, 1 - Page, 2 - Index
The ID of the team account
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
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.
[
{
"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
},
{
"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
}
]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.
[
{
"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
},
{
"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
}
]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.
[
{
"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
},
{
"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
}
]The name of the category
The ID of the project version where category has to be added
The position inside the parent category
The ID of the parent category. If empty, it will be added as top level category)
The content of the article, for any Editor type, use this property
0 - Folder, 1 - Page, 2 - Index
The ID of the team account
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Success
Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option, and source.
{
"data": [
{
"category_id": "b1a857d9-ecbc-4ab3-a0cb-ed22267ec999",
"success": true,
"details": "Successfully created category New Category 1"
},
{
"category_id": "975a72df-a8b6-4a4e-8081-be9baddd0467",
"success": true,
"details": "Successfully created category New Category 2"
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}bulk category response data
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
Kindly add some data to create category.
{
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Kindly verify the project_version_id is not empty, and peroform the task again.
{
"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": []
}Kindly verify the Name, and peroform the task again.
{
"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": []
}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.