Update a category
Changes the name, description, slug, locale, icon or position. Sending related_category_ids replaces the related-category list; omitting it leaves the existing list alone.
Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Path Parameters
The numeric ID of the category.
1
Body
The name of the category
"Category Name"
A description for the category
"Category description"
Category position in the portal list to sort
1
The category slug used in the URL
"category-name"
The locale of the category
"en"
The icon of the category as a string (emoji)
"๐"
To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.
1
To associate similar categories to each other, e.g same category of product documentation in different languages
2
Response
Success
Single-category responses are wrapped in a payload key.