Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
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
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information
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": []
}
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information