Publishes an category with an id

Updated on Dec 24, 2024

3 minute(s) read

Anand Murali

Prev Next

Post

Deprecated

/v2/Categories/{categoryId}/publish

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

Body parameters

Publish Category Request Example

This is an basic example for publish category. UserId and VersionNumber are mandatory.

{
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "version_number": 1,
  "publish_message": "Successfully Published"
}

object

user_id

string Required

The ID of the team account who is responsible for the publish

Min length1

version_number

integer (int32) Required

The version number of the category

Minimum1

Maximum32767

publish_message

string | null

Publish message for the category

Publish Category Request Example

This is an basic example for publish category. UserId and VersionNumber are mandatory.

{
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "version_number": 1,
  "publish_message": "Successfully Published"
}

object

user_id

string Required

The ID of the team account who is responsible for the publish

Min length1

version_number

integer (int32) Required

The version number of the category

Minimum1

Maximum32767

publish_message

string | null

Publish message for the category

Publish Category Request Example

This is an basic example for publish category. UserId and VersionNumber are mandatory.

{
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "version_number": 1,
  "publish_message": "Successfully Published"
}

object

user_id

string Required

The ID of the team account who is responsible for the publish

Min length1

version_number

integer (int32) Required

The version number of the category

Minimum1

Maximum32767

publish_message

string | null

Publish message for the category

Publish Category Request Example

This is an basic example for publish category. UserId and VersionNumber are mandatory.

{
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "version_number": 1,
  "publish_message": "Successfully Published"
}

object

user_id

string Required

The ID of the team account who is responsible for the publish

Min length1

version_number

integer (int32) Required

The version number of the category

Minimum1

Maximum32767

publish_message

string | null

Publish message for the category

Responses

200

Success

Successfully Published Category

Category page

{
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

data

Array of object (BulkCategoryResult) | null

bulk category 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

CategoryId not found

kindly verify the CategoryId and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Category not found.",
      "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": []
}

user_id not found

Kindly verify the user_id nad 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": []
}

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

Was this article helpful?