Deletes an category with an ID
- 26 Sep 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
Deletes an category with an ID
- Updated on 26 Sep 2023
- 3 Minutes to read
- Contributors
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
Delete
/v2/Categories/{categoryId}
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Path parameters
categoryId
stringRequired
The ID of the category
Responses
200
Success
Successfully Deleted
The category has been successfully deleted.
{
"extension_data": null,
"success": true,
"errors": null,
"warnings": [],
"information": null
}object
data
object (CategorySettingsCustomer)
slug
string
The slug of the category
seo_title
string
SEO title of the category
description
string
SEO description of the category
allow_comments
boolean
Allow comments for category
show_table_of_contents
boolean
True - Table of Contents will be enabled
False - Table of Contents will be disabled
featured_image_url
string
URL of the featured image
tags
Array of string
List of Tags associated to the category
string
status_indicator
integer (int32)
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
Valid values[0,1,2,3]
status_indicator_expiry_date
string (date-time)
The number of days after which the article status will be removed
exclude_from_search
boolean
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
related_articles
Array of object (RelatedArticleData)
The list of related article IDs to show in the knowledge base
object
id
string
The ID of the article
title
string
The title of the article
hidden
boolean
True indicates that the article is hidden
slug
string
The slug of the article
content_type
integer (int32)
0 - Markdown content; 1 - HTML content; 2 - Block Content
Valid values[0,1,2]
extension_data
object (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError)
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
stack_trace
string
Stack trace for error response message
description
string
Description for error cause
error_code
string
Error code for Api resonse
custom_data
object
warnings
Array of object (BaseWarning)
Warning in the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
Warning description
warning_code
string
warning code for customer Api base response
information
Array of object (BaseInformation)
Information passed by the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
status description for customer Api response information
400
Bad Request
Category not found
Kindly verify the Categotry Id and Langauage code, then peroform the task again.
{
"extension_data": null,
"success": true,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Category not found",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}object
data
object (CategorySettingsCustomer)
slug
string
The slug of the category
seo_title
string
SEO title of the category
description
string
SEO description of the category
allow_comments
boolean
Allow comments for category
show_table_of_contents
boolean
True - Table of Contents will be enabled
False - Table of Contents will be disabled
featured_image_url
string
URL of the featured image
tags
Array of string
List of Tags associated to the category
string
status_indicator
integer (int32)
Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom
Valid values[0,1,2,3]
status_indicator_expiry_date
string (date-time)
The number of days after which the article status will be removed
exclude_from_search
boolean
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
related_articles
Array of object (RelatedArticleData)
The list of related article IDs to show in the knowledge base
object
id
string
The ID of the article
title
string
The title of the article
hidden
boolean
True indicates that the article is hidden
slug
string
The slug of the article
content_type
integer (int32)
0 - Markdown content; 1 - HTML content; 2 - Block Content
Valid values[0,1,2]
extension_data
object (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError)
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
stack_trace
string
Stack trace for error response message
description
string
Description for error cause
error_code
string
Error code for Api resonse
custom_data
object
warnings
Array of object (BaseWarning)
Warning in the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
Warning description
warning_code
string
warning code for customer Api base response
information
Array of object (BaseInformation)
Information passed by the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
status description for customer Api response information
Was this article helpful?