Put
/v1/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
string Required

The ID of the category

Body parameters


object

name
string 

The name of the category


order
integer 

The position of the category. By default, it will be added at the end of the parent category.


parent_category_id
string 

The ID of the category where the category will be moved. By default, it will be created at the first level.


hidden
boolean 

Visibility status of the category. true - Category will be hidden; false - Category will be shown


icon
string 

The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)


language
string 

Language code of the category. If language is not specified, the category would be updated in the default language.



object

name
string 

The name of the category


order
integer 

The position of the category. By default, it will be added at the end of the parent category.


parent_category_id
string 

The ID of the category where the category will be moved. By default, it will be created at the first level.


hidden
boolean 

Visibility status of the category. true - Category will be hidden; false - Category will be shown


icon
string 

The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)


language
string 

Language code of the category. If language is not specified, the category would be updated in the default language.



object

name
string 

The name of the category


order
integer 

The position of the category. By default, it will be added at the end of the parent category.


parent_category_id
string 

The ID of the category where the category will be moved. By default, it will be created at the first level.


hidden
boolean 

Visibility status of the category. true - Category will be hidden; false - Category will be shown


icon
string 

The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)


language
string 

Language code of the category. If language is not specified, the category would be updated in the default language.



object

name
string 

The name of the category


order
integer 

The position of the category. By default, it will be added at the end of the parent category.


parent_category_id
string 

The ID of the category where the category will be moved. By default, it will be created at the first level.


hidden
boolean 

Visibility status of the category. true - Category will be hidden; false - Category will be shown


icon
string 

The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)


language
string 

Language code of the category. If language is not specified, the category would be updated in the default language.


Responses
200
400

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