Update a category page content with the ID
- 26 Sep 2023
- 7 Minutes to read
- Contributors
- Print
- DarkLight
Update a category page content with the ID
- Updated on 26 Sep 2023
- 7 Minutes to read
- Contributors
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
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
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
The title of the category
content
string
The content of the category, for any Editor type, use this property.
html_content
string 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 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)
The version number of the category to be updated. The latest version is updated by default.
translation_option
string
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
source
string
Free text used for future reference
updated_by
string
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
The title of the category
content
string
The content of the category, for any Editor type, use this property.
html_content
string 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 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)
The version number of the category to be updated. The latest version is updated by default.
translation_option
string
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
source
string
Free text used for future reference
updated_by
string
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
The title of the category
content
string
The content of the category, for any Editor type, use this property.
html_content
string 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 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)
The version number of the category to be updated. The latest version is updated by default.
translation_option
string
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
source
string
Free text used for future reference
updated_by
string
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
The title of the category
content
string
The content of the category, for any Editor type, use this property.
html_content
string 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 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)
The version number of the category to be updated. The latest version is updated by default.
translation_option
string
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
source
string
Free text used for future reference
updated_by
string
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": 5,
"order": 0,
"created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"authors": [],
"created_at": "2023-09-26T06:34:59.4897924Z",
"modified_at": "2023-09-26T06:34:59.4897931Z",
"slug": "updatetitleforcategorypage",
"is_fall_back_content": false
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}object
data
object (CategoryVersionDataCustomer)
id
string
The ID of the category
title
string
The title of the category
content
string
The content of the category
html_content
string
The HTML content of the category
block_content
string
The HTML content of the category (Block editor)
category_id
string
Existing category ID
project_version_id
string
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 page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked
Valid values[0,1,2,3,4,5]
order
integer (int32)
The position inside the parent category
created_by
string
The ID of the user that created the category
authors
Array of object (UserProfileCustomer)
The list of authors that contributed to this category
object
id
string
first_name
string
last_name
string
email_id
string
profile_logo_url
string
user_role
integer (int32)
Valid values[1,2,3,4,7]
last_login_at
string (date-time)
unique_user_name
string
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
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
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)
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
stack_trace
string
Stack trace for error response message
description
string
Description for error cause
error_code
string
Error code for Api resonse
custom_data
object
warnings
Array of object (BaseWarning)
Warning in the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
Warning description
warning_code
string
warning code for customer Api base response
information
Array of object (BaseInformation)
Information passed by the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
status description for customer Api response information
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.
{
"data": null,
"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": []
}object
data
object (CategoryVersionDataCustomer)
id
string
The ID of the category
title
string
The title of the category
content
string
The content of the category
html_content
string
The HTML content of the category
block_content
string
The HTML content of the category (Block editor)
category_id
string
Existing category ID
project_version_id
string
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 page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked
Valid values[0,1,2,3,4,5]
order
integer (int32)
The position inside the parent category
created_by
string
The ID of the user that created the category
authors
Array of object (UserProfileCustomer)
The list of authors that contributed to this category
object
id
string
first_name
string
last_name
string
email_id
string
profile_logo_url
string
user_role
integer (int32)
Valid values[1,2,3,4,7]
last_login_at
string (date-time)
unique_user_name
string
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
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
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)
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
stack_trace
string
Stack trace for error response message
description
string
Description for error cause
error_code
string
Error code for Api resonse
custom_data
object
warnings
Array of object (BaseWarning)
Warning in the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
Warning description
warning_code
string
warning code for customer Api base response
information
Array of object (BaseInformation)
Information passed by the customer API response
object
extension_data
object (ExtensionDataObject)
description
string
status description for customer Api response information
Was this article helpful?