Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
The ID of the article
Language code of the article
Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "0",
"source": "uat",
"order": 0
}Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "1",
"source": "uat",
"order": 0
}Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "2",
"source": "uat",
"order": 0
}The title of the article
The content of the article, for any Editor type, use this property.
The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)
The ID of the category. If the article has to be moved to another category, enter the desired category ID
Visibility status of the article. true - Article will be hidden; false - Article will be shown
The version number of the article to be updated. The latest version is updated by default.
Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).
Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "0",
"source": "uat",
"order": 0
}Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "1",
"source": "uat",
"order": 0
}Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "2",
"source": "uat",
"order": 0
}The title of the article
The content of the article, for any Editor type, use this property.
The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)
The ID of the category. If the article has to be moved to another category, enter the desired category ID
Visibility status of the article. true - Article will be hidden; false - Article will be shown
The version number of the article to be updated. The latest version is updated by default.
Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).
Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "0",
"source": "uat",
"order": 0
}Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "1",
"source": "uat",
"order": 0
}Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "2",
"source": "uat",
"order": 0
}The title of the article
The content of the article, for any Editor type, use this property.
The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)
The ID of the category. If the article has to be moved to another category, enter the desired category ID
Visibility status of the article. true - Article will be hidden; false - Article will be shown
The version number of the article to be updated. The latest version is updated by default.
Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).
Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option for default language,source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "0",
"source": "uat",
"order": 0
}Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as need translation, source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "1",
"source": "uat",
"order": 0
}Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option as translated, source and order.
{
"title": "updated article title",
"content": "Hi this is an API article Sample. This is updated.",
"html_content": "Hi this is an API article Sample. This is updated.
",
"category_id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"hidden": true,
"version_number": 1,
"translation_option": "2",
"source": "uat",
"order": 0
}The title of the article
The content of the article, for any Editor type, use this property.
The HTML content of the article. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API. Kindly use content property instead of this.)
The ID of the category. If the article has to be moved to another category, enter the desired category ID
Visibility status of the article. true - Article will be hidden; false - Article will be shown
The version number of the article to be updated. The latest version is updated by default.
Translation status of the article. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
To update the position of the article in the category tree. (Default value is 0, and the order starts from 1 when explicitly set or updated).
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": "a1096061-e842-41fd-9085-494095e401b9",
"title": "Knowledge bases are much easier to design and edit",
"content": "Have you ever edited a Wikipedia page? You have to break the flow of text to add tags, and when you want to connect two articles together you have to just hope that nobody changes the other article’s name, lest you end up with a rusty red “dead link.”To be fair,Wikipedia has actually made good strides in making their Wiki software easy to use for anybody, but opening up the editor is still a bit of a shock since you don’t see the familiar webpage you just clicked on. With a knowledge base, what you see is what you get.You don’t have to train anybody on how to add or edit pages because the whole thing is extremely intuitive. Anybody can learn to navigate an edit page in seconds flat.",
"html_content": null,
"category_id": "de104b39-db97-4509-8d4c-deeac74d448b",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"version_number": 1,
"public_version": 1,
"latest_version": 2,
"enable_rtl": false,
"hidden": false,
"status": 0,
"order": 0,
"created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"authors": [
{
"id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"first_name": "peter",
"last_name": "jone",
"user_description": null,
"unique_user_name": "peter-jone",
"email_id": "peterjone@mail.com",
"profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D",
"profile_logo_cdn_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D",
"is_enterprise_user": false
}
],
"created_at": "2024-06-13T14:30:00Z",
"modified_at": "2024-06-13T14:30:00Z",
"slug": "Knowledge-bases-are-much-easier-to-design-and edit",
"is_fall_back_content": false,
"description": null,
"category_type": 0,
"content_type": null,
"is_shared_article": false,
"translation_option": 0,
"url": "https://example.com/v1/docs/en/getting-started"
},
"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 verify the article Id and Langauage code, and peroform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Article not found",
"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