Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
The ID of the category
Language code of the 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"
}
The title of the category
The content of the category, for any Editor type, use this property.
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.)
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.)
The version number of the category to be updated. The latest version is updated by default.
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
The ID of the team account responsible for the category update
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"
}
The title of the category
The content of the category, for any Editor type, use this property.
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.)
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.)
The version number of the category to be updated. The latest version is updated by default.
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
The ID of the team account responsible for the category update
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"
}
The title of the category
The content of the category, for any Editor type, use this property.
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.)
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.)
The version number of the category to be updated. The latest version is updated by default.
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
The ID of the team account responsible for the category update
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"
}
The title of the category
The content of the category, for any Editor type, use this property.
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.)
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.)
The version number of the category to be updated. The latest version is updated by default.
Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated
Free text used for future reference
The ID of the team account responsible for the category update
Success
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": []
}
category version data
The ID of the category
The title of the category
The content of the category
The HTML content of the category
The HTML content of the category (Block editor)
Existing category ID
Existing project version ID
Category Version Number
The ID of the project version where this category is located
The latest version number of this category
Indicates if Right to Left alignment is enabled for the category language
Indicates if the category is visible on the site
The status of the category: 0 - Draft, 3 - Published
The position inside the parent category
The ID of the user that created the category
The list of authors that contributed to this category
SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user
The date the category was created
The date the category was last modified
The slug of the category
Indicates whether the category content is a fallback of the default language content or not
Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information
Bad Request
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": []
}
Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information