category_create_update_payload
namestring
The name of the category
Example:
Category Namedescriptionstring
A description for the category
Example:
Category descriptionpositioninteger
Category position in the portal list to sort
Example:
1slugstring
The category slug used in the URL
Example:
category-namelocalestring
The locale of the category
Example:
eniconstring
The icon of the category as a string (emoji)
Example:
📚parent_category_idinteger
To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.
Example:
1associated_category_idinteger
To associate similar categories to each other, e.g same category of product documentation in different languages
Example:
2category_create_update_payload
{
"name": "Category Name",
"description": "Category description",
"position": 1,
"slug": "category-name",
"locale": "en",
"icon": "📚",
"parent_category_id": 1,
"associated_category_id": 2
}