Contents x
Update a category with the ID
  • 16 Mar 2023
  • 5 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Update a category with the ID

  • Updated on 16 Mar 2023
  • 5 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Put
/v2/Categories/{categoryId}
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
string Required

The ID of the category

Body parameters
Updating Category

Request for Updating Category Name.\n if you are not using parent_category_id then remove the field.

{
  "name": "UpdatedName",
  "order": 0,
  "parent_category_id": "",
  "hidden": false,
  "icon": "",
  "language": "en"
}
object
name
string

The name of the category

order
integer

The position of the category. By default, it will be added at the end of the parent category.

parent_category_id
string

The ID of the category where the category will be moved. By default, it will be created at the first level.

hidden
boolean

Visibility status of the category. true - Category will be hidden; false - Category will be shown

icon
string

The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)

language
string

Language code of the category. If language is not specified, the category would be updated in the default language.

Updating Category

Request for Updating Category Name.\n if you are not using parent_category_id then remove the field.

{
  "name": "UpdatedName",
  "order": 0,
  "parent_category_id": "",
  "hidden": false,
  "icon": "",
  "language": "en"
}
object
name
string

The name of the category

order
integer

The position of the category. By default, it will be added at the end of the parent category.

parent_category_id
string

The ID of the category where the category will be moved. By default, it will be created at the first level.

hidden
boolean

Visibility status of the category. true - Category will be hidden; false - Category will be shown

icon
string

The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)

language
string

Language code of the category. If language is not specified, the category would be updated in the default language.

Updating Category

Request for Updating Category Name.\n if you are not using parent_category_id then remove the field.

{
  "name": "UpdatedName",
  "order": 0,
  "parent_category_id": "",
  "hidden": false,
  "icon": "",
  "language": "en"
}
object
name
string

The name of the category

order
integer

The position of the category. By default, it will be added at the end of the parent category.

parent_category_id
string

The ID of the category where the category will be moved. By default, it will be created at the first level.

hidden
boolean

Visibility status of the category. true - Category will be hidden; false - Category will be shown

icon
string

The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)

language
string

Language code of the category. If language is not specified, the category would be updated in the default language.

Updating Category

Request for Updating Category Name.\n if you are not using parent_category_id then remove the field.

{
  "name": "UpdatedName",
  "order": 0,
  "parent_category_id": "",
  "hidden": false,
  "icon": "",
  "language": "en"
}
object
name
string

The name of the category

order
integer

The position of the category. By default, it will be added at the end of the parent category.

parent_category_id
string

The ID of the category where the category will be moved. By default, it will be created at the first level.

hidden
boolean

Visibility status of the category. true - Category will be hidden; false - Category will be shown

icon
string

The icon of the category. Specify the Unicode icon. Example: 📜 (Windows 10 - Win key + . or Mac ⌃-⌘-Space Bar to open emoji menu)

language
string

Language code of the category. If language is not specified, the category would be updated in the default language.

Responses
200

Success

Successfully Updated Category

Updated Catgory information is shown in this response.

{
  "data": {
    "id": "68212cec-7a9b-4323-9bb8-33865444a508",
    "name": "UpdatedName",
    "order": 0,
    "icon": ""
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
object
id
string

The ID of the category

name
string

Name of the category

order
integer

The position inside the parent category

icon
string

Unicode representation of the icon

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

400

Bad Request

Non-Empty body is required.

This response is due to an empty request body. \n Kindly make some body parameters to get success response.

{
  "data": {
    "id": null,
    "name": null,
    "order": 0,
    "icon": null
  },
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "A non-empty request body is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
parent_category_id should be removed if its null or empty..

Kindly remove the parent_category_id, it should not be null or empty. \n if there you need an parent_category_id with another category please add it.

{
  "data": {
    "id": null,
    "name": null,
    "order": 0,
    "icon": null
  },
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Object reference not set to an instance of an object.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
data
object
id
string

The ID of the category

name
string

Name of the category

order
integer

The position inside the parent category

icon
string

Unicode representation of the icon

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next