Post
/v1/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 

The position inside the parent category


parent_category_id
string 

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


content
string 

The content of category page. Both markdown and HTML content are accepted.


category_type
integer 

Valid values[0,1,2]
user_id
string 



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 

The position inside the parent category


parent_category_id
string 

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


content
string 

The content of category page. Both markdown and HTML content are accepted.


category_type
integer 

Valid values[0,1,2]
user_id
string 



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 

The position inside the parent category


parent_category_id
string 

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


content
string 

The content of category page. Both markdown and HTML content are accepted.


category_type
integer 

Valid values[0,1,2]
user_id
string 



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 

The position inside the parent category


parent_category_id
string 

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


content
string 

The content of category page. Both markdown and HTML content are accepted.


category_type
integer 

Valid values[0,1,2]
user_id
string 


Responses
200
400
Show example

Success

Collapse all

object

data
object

id
string 

The ID of the category


name
string 

Name of the category


order
integer 

The position inside the parent category


icon
string 

Unicode representation of the icon


extension_data
object

success
boolean 

Status indication for customer Api response


errors
Array of object

Errors in the customer Api response


object

warnings
Array of object

Warning in the customer Api response


object

information
Array of object

Information passed by the customer Api response


object