Put
/v2/Categories/{categoryId}/content/{langCode}
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

langCode
stringRequired

Language code of the category

Default"en"
Body parameters
object
title
string | null

The title of the category

content
string | null

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

html_content
string | null Deprecated

The HTML content of the category. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

block_content
string | null Deprecated

The HTML content of the category. If the editor type is Block Editor (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

version_number
integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option
string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source
string | null

Free text used for future reference

updated_by
string | null

The ID of the team account responsible for the category update

object
title
string | null

The title of the category

content
string | null

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

html_content
string | null Deprecated

The HTML content of the category. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

block_content
string | null Deprecated

The HTML content of the category. If the editor type is Block Editor (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

version_number
integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option
string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source
string | null

Free text used for future reference

updated_by
string | null

The ID of the team account responsible for the category update

object
title
string | null

The title of the category

content
string | null

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

html_content
string | null Deprecated

The HTML content of the category. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

block_content
string | null Deprecated

The HTML content of the category. If the editor type is Block Editor (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

version_number
integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option
string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source
string | null

Free text used for future reference

updated_by
string | null

The ID of the team account responsible for the category update

object
title
string | null

The title of the category

content
string | null

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

html_content
string | null Deprecated

The HTML content of the category. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

block_content
string | null Deprecated

The HTML content of the category. If the editor type is Block Editor (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

version_number
integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option
string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source
string | null

Free text used for future reference

updated_by
string | null

The ID of the team account responsible for the category update

Responses
200
400

Success

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

The ID of the category

title
string | null

The title of the category

content
string | null

The content of the category

html_content
string | null

The HTML content of the category

block_content
string | null

The HTML content of the category (Block editor)

category_id
string | null

Existing category ID

project_version_id
string | null

Existing project version ID

version_number
integer (int32)

Category Version Number

public_version
integer (int32)

The ID of the project version where this category is located

latest_version
integer (int32)

The latest version number of this category

enable_rtl
boolean

Indicates if Right to Left alignment is enabled for the category language

hidden
boolean

Indicates if the category is visible on the site

status
integer (int32)

The status of the article: 0 - Draft, 3 - Published

Valid values[ 0, 3 ]
order
integer (int32)

The position inside the parent category

created_by
string | null

The ID of the user that created the category

authors
Array of object (UserProfileCustomer) | null

The list of authors that contributed to this category

object
created_at
string (date-time)

The date the category was created

modified_at
string (date-time)

The date the category was last modified

slug
string | null

The slug of the category

is_fall_back_content
boolean

Indicates whether the category content is a fallback of the default language content or not

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