Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Language code of the category
Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.
{
"categories": [
{
"category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
"version_number": 1
},
{
"category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
"version_number": 1
}
],
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"unpublish_message": "Unpublish category"
}
Details of the categories need to be unpublished
The ID of the category
The version number of the category to be unpublished
The ID of the team account that will be marked as the contributor of this unpublish
The project version ID where the category exists.
The unpublish message of the category
Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.
{
"categories": [
{
"category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
"version_number": 1
},
{
"category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
"version_number": 1
}
],
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"unpublish_message": "Unpublish category"
}
Details of the categories need to be unpublished
The ID of the category
The version number of the category to be unpublished
The ID of the team account that will be marked as the contributor of this unpublish
The project version ID where the category exists.
The unpublish message of the category
Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.
{
"categories": [
{
"category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
"version_number": 1
},
{
"category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
"version_number": 1
}
],
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"unpublish_message": "Unpublish category"
}
Details of the categories need to be unpublished
The ID of the category
The version number of the category to be unpublished
The ID of the team account that will be marked as the contributor of this unpublish
The project version ID where the category exists.
The unpublish message of the category
Category page has unpublished successfully. the category_id, poject_version_id, user_id, and version_number are mandatory.
{
"categories": [
{
"category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
"version_number": 1
},
{
"category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
"version_number": 1
}
],
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"unpublish_message": "Unpublish category"
}
Details of the categories need to be unpublished
The ID of the category
The version number of the category to be unpublished
The ID of the team account that will be marked as the contributor of this unpublish
The project version ID where the category exists.
The unpublish message of the category
Success
Unublishing a page category with CategoryId, project_veriond_id, langCode, user_id, version_number, and unpublish_message.
{
"data": [
{
"category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
"success": true,
"details": "Successfully unpublished category with an id 152e9239-1a5a-4044-b5de-1030f49976b6s"
},
{
"category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
"success": true,
"details": "Successfully unpublished category with an id gr32e9239-1a5a-4044-b5de-1030f499fe6sr"
}
],
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
Bulk unpublish article response data
The ID of the category
True
- Category is published
False
- Category is not published
Description of the action performed
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
Kindly verify the category_id and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The CategoryId field is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}
Kindly verify the user_id and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The UserId field is required.",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}
Kindly verify the version_number and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "The field VersionNumber must be between 1 and 32767.",
"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