user-site

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

stringRequired

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": "814bd3cc-4cd1-4f97-adde-d4d644e9fe78",
  "hidden": false,
  "icon": "",
  "language": "en"
}

object

name

string | null

The name of the category

order

integer (int32)

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

parent_category_id

string | null

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 | null

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

language

string | null

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": "814bd3cc-4cd1-4f97-adde-d4d644e9fe78",
  "hidden": false,
  "icon": "",
  "language": "en"
}

object

name

string | null

The name of the category

order

integer (int32)

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

parent_category_id

string | null

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 | null

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

language

string | null

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": "814bd3cc-4cd1-4f97-adde-d4d644e9fe78",
  "hidden": false,
  "icon": "",
  "language": "en"
}

object

name

string | null

The name of the category

order

integer (int32)

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

parent_category_id

string | null

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 | null

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

language

string | null

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": "814bd3cc-4cd1-4f97-adde-d4d644e9fe78",
  "hidden": false,
  "icon": "",
  "language": "en"
}

object

name

string | null

The name of the category

order

integer (int32)

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

parent_category_id

string | null

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 | null

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

language

string | null

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 (CategorySimpleData)

string | null

The ID of the category

name

string | null

Name of the category

order

integer (int32)

The position inside the parent category

icon

string | null

Unicode representation of the icon

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

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

Non-Empty body is required.

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

{
  "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.

{
  "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

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

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