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
400
Show example

Success

Collapse all
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
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
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
information
Array of object (BaseInformation)

Information passed by the customer API response

object