Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Create an article with the title, categoryId, projevtVersionId, and userId.
{
"title": "New Article",
"content": "This is my new article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
}The title of the article
The content of the article, for any Editor type, use this property
The ID of the category where the article will be created, CategoryId will be null for custom pages
The project version ID in which the article will be created
The position of the article in the category tree (By default, it will be placed at the bottom of the category)
The ID of the team account that will be marked as a contributor of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Create an article with the title, categoryId, projevtVersionId, and userId.
{
"title": "New Article",
"content": "This is my new article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
}The title of the article
The content of the article, for any Editor type, use this property
The ID of the category where the article will be created, CategoryId will be null for custom pages
The project version ID in which the article will be created
The position of the article in the category tree (By default, it will be placed at the bottom of the category)
The ID of the team account that will be marked as a contributor of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Create an article with the title, categoryId, projevtVersionId, and userId.
{
"title": "New Article",
"content": "This is my new article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
}The title of the article
The content of the article, for any Editor type, use this property
The ID of the category where the article will be created, CategoryId will be null for custom pages
The project version ID in which the article will be created
The position of the article in the category tree (By default, it will be placed at the bottom of the category)
The ID of the team account that will be marked as a contributor of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Create an article with the title, categoryId, projevtVersionId, and userId.
{
"title": "New Article",
"content": "This is my new article Content.",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 0,
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"content_type": null,
"article_type": null
}The title of the article
The content of the article, for any Editor type, use this property
The ID of the category where the article will be created, CategoryId will be null for custom pages
The project version ID in which the article will be created
The position of the article in the category tree (By default, it will be placed at the bottom of the category)
The ID of the team account that will be marked as a contributor of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Success
The article has been created under the following category. you can use the article Id to view the article in the portal.
{
"data": {
"id": "925b69b9-f241-4d89-9e3e-208a98dfc8eb",
"title": "Sample Article",
"public_version": 0,
"latest_version": 1,
"language_code": null,
"hidden": false,
"status": 0,
"order": 3,
"slug": "sample-article",
"content_type": null,
"translation_option": 0,
"is_shared_article": false,
"modified_at": null
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Create article response data
The ID of the article
The article title
The article version number(revision) that is currently published
The latest version number of this article
The default language code
Indicates if the article is visible on the site
The status of the article: 0 - Draft, 3 - Published
The position of the article inside the parent category
The slug of the article
The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2
The Translation status of the article
True indicates that the article is shared
Article modified date time
Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information
Bad Request
Kindly check your user Id and perform the task again. Find your user Id at /v2/Teams.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de81' does not exist in your project.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly check the category_id from /v2/ProjectVersions//categories and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Unable to find specified parent category with an id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly check the project_version_id from /v2/ProjectVersions and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The supplied project version id 46f48bc7-760f-4b07-b2d2-fce4aa8ba2349 does not exist in your project.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly check the title is empty or null, and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The Title field is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information