Unpublishes multiple categories

Prev Next
Delete
/v2/Categories/bulkpublish/{langCode}
Security
API Key: api_token
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters
langCode
stringRequired

Language code of the category

Default"en"
Body parameters
Unpublished category request

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"
}
Expand All
object
categories
Array of object (BulkUnpublishCategory) Required

Details of the categories need to be unpublished

object
category_id
string Required

The ID of the category

Min length1
version_number
integer (int32) Required

The version number of the category to be unpublished

Minimum1
Maximum32767
user_id
string Required

The ID of the team account that will be marked as the contributor of this unpublish

Min length1
project_version_id
string Required

The project version ID where the category exists.

Min length1
unpublish_message
string | null

The unpublish message of the category

Unpublished category request

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"
}
Expand All
object
categories
Array of object (BulkUnpublishCategory) Required

Details of the categories need to be unpublished

object
category_id
string Required

The ID of the category

Min length1
version_number
integer (int32) Required

The version number of the category to be unpublished

Minimum1
Maximum32767
user_id
string Required

The ID of the team account that will be marked as the contributor of this unpublish

Min length1
project_version_id
string Required

The project version ID where the category exists.

Min length1
unpublish_message
string | null

The unpublish message of the category

Unpublished category request

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"
}
Expand All
object
categories
Array of object (BulkUnpublishCategory) Required

Details of the categories need to be unpublished

object
category_id
string Required

The ID of the category

Min length1
version_number
integer (int32) Required

The version number of the category to be unpublished

Minimum1
Maximum32767
user_id
string Required

The ID of the team account that will be marked as the contributor of this unpublish

Min length1
project_version_id
string Required

The project version ID where the category exists.

Min length1
unpublish_message
string | null

The unpublish message of the category

Unpublished category request

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"
}
Expand All
object
categories
Array of object (BulkUnpublishCategory) Required

Details of the categories need to be unpublished

object
category_id
string Required

The ID of the category

Min length1
version_number
integer (int32) Required

The version number of the category to be unpublished

Minimum1
Maximum32767
user_id
string Required

The ID of the team account that will be marked as the contributor of this unpublish

Min length1
project_version_id
string Required

The project version ID where the category exists.

Min length1
unpublish_message
string | null

The unpublish message of the category

Responses
200

Success

Successfully Unublished Category

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": []
}
Expand All
object
data
Array of object (BulkCategoryResult) | null

Bulk unpublish article response data

object
category_id
string | null

The ID of the category

success
boolean

True - Category is published False - Category is not published

details
string | null

Description of the action performed

extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information

400

Bad Request

category_id not found

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": []
}
user_id not found

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": []
}
version_number not found

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": []
}
Expand All
object
extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information