Post
/v2/Categories
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Body parameters
Show example
object
name
string Required

The name of the category

Min length1
project_version_id
string Required

The ID of the project version where category has to be added

Min length1
order
integer (int32)

The position inside the parent category

parent_category_id
string | null

The ID of the parent category. If empty, it will be added as top level category)

content
string | null

The content of the article, for any Editor type, use this property

category_type
integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[ 0, 1, 2 ]
user_id
string | null

The ID of the team account

content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
object
name
string Required

The name of the category

Min length1
project_version_id
string Required

The ID of the project version where category has to be added

Min length1
order
integer (int32)

The position inside the parent category

parent_category_id
string | null

The ID of the parent category. If empty, it will be added as top level category)

content
string | null

The content of the article, for any Editor type, use this property

category_type
integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[ 0, 1, 2 ]
user_id
string | null

The ID of the team account

content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
object
name
string Required

The name of the category

Min length1
project_version_id
string Required

The ID of the project version where category has to be added

Min length1
order
integer (int32)

The position inside the parent category

parent_category_id
string | null

The ID of the parent category. If empty, it will be added as top level category)

content
string | null

The content of the article, for any Editor type, use this property

category_type
integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[ 0, 1, 2 ]
user_id
string | null

The ID of the team account

content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
object
name
string Required

The name of the category

Min length1
project_version_id
string Required

The ID of the project version where category has to be added

Min length1
order
integer (int32)

The position inside the parent category

parent_category_id
string | null

The ID of the parent category. If empty, it will be added as top level category)

content
string | null

The content of the article, for any Editor type, use this property

category_type
integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[ 0, 1, 2 ]
user_id
string | null

The ID of the team account

content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
Responses
200
400
Show example

Success

Collapse all
object
data
object (CategorySimpleData)
id
string | null

The ID of the category

name
string | null

Name of the category

order
integer (int32)

The position inside the parent category

icon
string | null

Unicode representation of the icon

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
information
Array of object (BaseInformation) | null

Information passed by the customer API response

object