Publishes multiple categories

Prev Next
Post
/v2/Categories/bulkpublish/{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
langCode
stringRequired

Language code of the category

Default"en"
Body parameters
Published Category Request

Category page has published successfully. the category_id, user_id, and version_number are mandatory.

[
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "version_number": 1,
    "publish_message": "Publish Success"
  },
  {
    "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
    "user_id": "edr1efc6f-e968-4e95-82eb-ccad61559deef3",
    "version_number": 1,
    "publish_message": "Publish Success"
  }
]
Array of object
object
category_id
string Required

The ID of the category

Min length1
user_id
string Required

The ID of the team account responsible for the publish

Min length1
version_number
integer (int32) Required

Version number of the category page

Minimum1
Maximum32767
publish_message
string | null

Publish message for the category

Published Category Request

Category page has published successfully. the category_id, user_id, and version_number are mandatory.

[
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "version_number": 1,
    "publish_message": "Publish Success"
  },
  {
    "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
    "user_id": "edr1efc6f-e968-4e95-82eb-ccad61559deef3",
    "version_number": 1,
    "publish_message": "Publish Success"
  }
]
Array of object
object
category_id
string Required

The ID of the category

Min length1
user_id
string Required

The ID of the team account responsible for the publish

Min length1
version_number
integer (int32) Required

Version number of the category page

Minimum1
Maximum32767
publish_message
string | null

Publish message for the category

Published Category Request

Category page has published successfully. the category_id, user_id, and version_number are mandatory.

[
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "version_number": 1,
    "publish_message": "Publish Success"
  },
  {
    "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
    "user_id": "edr1efc6f-e968-4e95-82eb-ccad61559deef3",
    "version_number": 1,
    "publish_message": "Publish Success"
  }
]
Array of object
object
category_id
string Required

The ID of the category

Min length1
user_id
string Required

The ID of the team account responsible for the publish

Min length1
version_number
integer (int32) Required

Version number of the category page

Minimum1
Maximum32767
publish_message
string | null

Publish message for the category

Published Category Request

Category page has published successfully. the category_id, user_id, and version_number are mandatory.

[
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
    "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
    "version_number": 1,
    "publish_message": "Publish Success"
  },
  {
    "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
    "user_id": "edr1efc6f-e968-4e95-82eb-ccad61559deef3",
    "version_number": 1,
    "publish_message": "Publish Success"
  }
]
Array of object
object
category_id
string Required

The ID of the category

Min length1
user_id
string Required

The ID of the team account responsible for the publish

Min length1
version_number
integer (int32) Required

Version number of the category page

Minimum1
Maximum32767
publish_message
string | null

Publish message for the category

Responses
200

Success

Successfully Published Category

Category page

{
  "data": [
    {
      "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6s",
      "success": true,
      "details": "Bulk Publish Success"
    },
    {
      "category_id": "gr32e9239-1a5a-4044-b5de-1030f499fe6sr",
      "success": true,
      "details": "Bulk Publish Success"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object (BulkCategoryResult) | null
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

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

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

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.