Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
The ID of the category
Language code of the category
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"slug": "updatedslug",
"seo_title": "updatedSeoTitle",
"description": "This is the description in updating category settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 1,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false
}The slug of the article
The SEO title of the article
The SEO description of the article
Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled
Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled
Custom article tags
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The date-time when the public article status is removed
true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base
true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information
The list of related article IDs to show in the knowledge base
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"slug": "updatedslug",
"seo_title": "updatedSeoTitle",
"description": "This is the description in updating category settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 1,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false
}The slug of the article
The SEO title of the article
The SEO description of the article
Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled
Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled
Custom article tags
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The date-time when the public article status is removed
true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base
true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information
The list of related article IDs to show in the knowledge base
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"slug": "updatedslug",
"seo_title": "updatedSeoTitle",
"description": "This is the description in updating category settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 1,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false
}The slug of the article
The SEO title of the article
The SEO description of the article
Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled
Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled
Custom article tags
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The date-time when the public article status is removed
true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base
true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information
The list of related article IDs to show in the knowledge base
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"slug": "updatedslug",
"seo_title": "updatedSeoTitle",
"description": "This is the description in updating category settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 1,
"status_indicator_expiry_date": "2024-06-13T14:30:00Z",
"exclude_from_search": true,
"exclude_from_ai_search": false,
"related_articles": [],
"content_type": 0,
"is_acknowledgement_enabled": false
}The slug of the article
The SEO title of the article
The SEO description of the article
Enable or disable the commenting on the article. true - Commenting will be enabled; false - Commenting will be disabled
Enable or disable the Table of Contents (TOC) for the article in the knowledge base. true - TOC will be enabled; false - TOC will be disabled
Custom article tags
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The date-time when the public article status is removed
true - The article will not appear in search results in the knowledge base; false - The article will appear in search results in the knowledge base
true - The Eddy-AI assistant will not fetch information from this article; false - The Eddy-AI assistant will not exclude this article while fetching information
The list of related article IDs to show in the knowledge base
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Success
This response indicate a category settings has been successfully updated.
{
"data": null,
"extension_data": null,
"success": false,
"errors": [],
"warnings": [],
"information": []
}This is to get category settings data
The slug of the category
SEO title of the category
SEO description of the category
Allow comments for category
True - Table of Contents will be enabled
False - Table of Contents will be disabled
URL of the featured image
List of Tags associated to the category
Category status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
The number of days after which the article status will be removed
true - The caetgory will not appear in search results in the knowledge base false - The category will appear in search results in the knowledge base
true - The AI search assistant will not fetch information from this page category; false - The AI search assistant will not exclude this page category while fetching information
The list of related article IDs to show in the knowledge base
The ID of the article
The title of the article
True indicates that the article is hidden
The slug of the article
0 - Markdown content; 1 - HTML content
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 verifty the category Id or the langCode, and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": ".Category not found",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "A non-empty request body 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