Update a category page content with the ID

Prev Next
Put
/v2/Categories/{categoryId}/content/{langCode}
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Path parameters
categoryId
stringRequired

The ID of the category

langCode
stringRequired

Language code of the category

Default"en"
Body parameters
Successfully Updated Category

Updated Catgory information is shown in this response.

{
  "title": "UpdateTitleForCategoryPage",
  "content": "This is my updated content.",
  "html_content": "

This is my updated content,

", "block_content": "

This is my updated content,

", "version_number": 1, "translation_option": "", "source": "", "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8" }
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

Successfully Updated Category

Updated Catgory information is shown in this response.

{
  "title": "UpdateTitleForCategoryPage",
  "content": "This is my updated content.",
  "html_content": "

This is my updated content,

", "block_content": "

This is my updated content,

", "version_number": 1, "translation_option": "", "source": "", "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8" }
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

Successfully Updated Category

Updated Catgory information is shown in this response.

{
  "title": "UpdateTitleForCategoryPage",
  "content": "This is my updated content.",
  "html_content": "

This is my updated content,

", "block_content": "

This is my updated content,

", "version_number": 1, "translation_option": "", "source": "", "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8" }
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

Successfully Updated Category

Updated Catgory information is shown in this response.

{
  "title": "UpdateTitleForCategoryPage",
  "content": "This is my updated content.",
  "html_content": "

This is my updated content,

", "block_content": "

This is my updated content,

", "version_number": 1, "translation_option": "", "source": "", "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8" }
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

Success

Successfully Updated Category

Updated Catgory information is shown in this response.

{
  "data": {
    "id": "d6f49c75-1eea-4101-bfd4-fd314f57815d",
    "title": "UpdateTitleForCategoryPage",
    "content": "This is my updated content.",
    "html_content": "

This is my updated content.

\n", "block_content": null, "category_id": "d6f49c75-1eea-4101-bfd4-fd314f57815d", "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234", "version_number": 2, "public_version": 1, "latest_version": 2, "enable_rtl": false, "hidden": false, "status": 0, "order": 0, "created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8", "authors": [], "created_at": "2024-06-13T14:30:00Z", "modified_at": "2024-06-13T14:30:00Z", "slug": "updatetitleforcategorypage", "is_fall_back_content": false }, "extension_data": null, "success": true, "errors": [], "warnings": [], "information": [] }
Expand All
object
data
object | null

category version data

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 category: 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
id
string | null
first_name
string | null
last_name
string | null
email_id
string | null
profile_logo_url
string | null
user_role
integer (int32)
Valid values[ 1, 2, 3, 4, 7 ]
last_login_at
string (date-time) | null
unique_user_name
string | null
sso_user_type
integer (int32)

SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user

Valid values[ 0, 1, 2 ]
is_sso_user
boolean
is_active
boolean
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 | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

400

Bad Request

Non-Empty body is required.

This response is due to an empty request body. \n Kindly make some body parameters to get success response.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "A non-empty request body is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.