Put
/v2/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
stringRequired

The ID of the category

Body parameters
object
name
string | null

The name of the category

order
integer (int32)

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

parent_category_id
string | null

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 | null

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

language
string | null

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

object
name
string | null

The name of the category

order
integer (int32)

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

parent_category_id
string | null

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 | null

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

language
string | null

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

object
name
string | null

The name of the category

order
integer (int32)

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

parent_category_id
string | null

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 | null

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

language
string | null

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

object
name
string | null

The name of the category

order
integer (int32)

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

parent_category_id
string | null

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 | null

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

language
string | null

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 (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