-
Print
-
DarkLight
Updates settings for the article
The ID of the article
Language code of the article
This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.
{
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2023-03-16T13:17:47.3670896Z",
"exclude_from_search": true,
"related_articles": [],
"content_type": 0
}
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
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
The list of related article IDs to show in the knowledge base
This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.
{
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2023-03-16T13:17:47.3670896Z",
"exclude_from_search": true,
"related_articles": [],
"content_type": 0
}
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
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
The list of related article IDs to show in the knowledge base
This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.
{
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2023-03-16T13:17:47.3670896Z",
"exclude_from_search": true,
"related_articles": [],
"content_type": 0
}
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
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
The list of related article IDs to show in the knowledge base
This request is used to update the article settings. Kindly make sure the changes for updating your parameters has done successfully.
{
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2023-03-16T13:17:47.3670896Z",
"exclude_from_search": true,
"related_articles": [],
"content_type": 0
}
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
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
The list of related article IDs to show in the knowledge base
Success
This response indicate a article settings has been successfully updated.
{
"data": {
"slug": "updatearticlesettings",
"seo_title": "update",
"description": "This is the description for updating article settings.",
"allow_comments": true,
"show_table_of_contents": true,
"featured_image_url": "",
"tags": [],
"status_indicator": 2,
"status_indicator_expiry_date": "2023-03-16T13:17:47.3672054Z",
"exclude_from_search": true,
"related_articles": []
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": [
{
"extension_data": null,
"description": "Article settings updated successfully"
}
]
}
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 resonse
Warning 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
This response is due to an empty request body. \n Kindly make some body parameters to get success response.
{
"data": null,
"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": []
}
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 resonse
Warning 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