Update the Category Type

  • Updated on Sep 2, 2024
  • 1 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
Put
/v2/Categories/{categoryId}/updateCategoryType
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

Query parameters
categoryType
integer (int32) Required

Category type (0-Folder, 1-Page, 2-Index)

Valid values[ 0, 1, 2 ]
userId
stringRequired

The ID of the team account

Responses
200

Success

Category type Updated Successfully

Updated the category type. Status updated successfully.

{
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
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 (ExtensionDataObject)
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 (ExtensionDataObject)
description
string | null

status description for customer Api response information

400

Bad Request

CategoryId not found

Kindly update the category Id and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}
userId not found

Kindly update the user Id and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
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 (ExtensionDataObject)
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 (ExtensionDataObject)
description
string | null

status description for customer Api response information