Adds a new category

26 Sep 2023
7 Minutes to read
Contributors

Print
Share
Dark
Light

Adds a new category

Updated on 26 Sep 2023
7 Minutes to read
Contributors

Print
Share
Dark
Light

Article Summary

Share feedback

Thanks for sharing your feedback!

Post

/v2/Categories

Security

API Key

Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Body parameters

Create a new Category as Folder.

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 0,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

Create a new Category as Page .

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 1,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

Create a new Category as Index.

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 2,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

object

name

string Required

The name of the category

Min length1

project_version_id

string Required

The ID of the project version where category has to be added

Min length1

order

integer (int32)

The position inside the parent category

parent_category_id

string

The ID of the parent category. If empty, it will be added as top level category)

content

string

The content of the article, for any Editor type, use this property

category_type

integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[0,1,2]

user_id

string

The ID of the team account

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[0,1,2]

Create a new Category as Folder.

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 0,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

Create a new Category as Page .

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 1,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

Create a new Category as Index.

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 2,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

object

name

string Required

The name of the category

Min length1

project_version_id

string Required

The ID of the project version where category has to be added

Min length1

order

integer (int32)

The position inside the parent category

parent_category_id

string

The ID of the parent category. If empty, it will be added as top level category)

content

string

The content of the article, for any Editor type, use this property

category_type

integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[0,1,2]

user_id

string

The ID of the team account

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[0,1,2]

Create a new Category as Folder.

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 0,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

Create a new Category as Page .

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 1,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

Create a new Category as Index.

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 2,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

object

name

string Required

The name of the category

Min length1

project_version_id

string Required

The ID of the project version where category has to be added

Min length1

order

integer (int32)

The position inside the parent category

parent_category_id

string

The ID of the parent category. If empty, it will be added as top level category)

content

string

The content of the article, for any Editor type, use this property

category_type

integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[0,1,2]

user_id

string

The ID of the team account

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[0,1,2]

Create a new Category as Folder.

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Folder.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 0,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

Create a new Category as Page .

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Page.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 1,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

Create a new Category as Index.

Add Name, Project_Version_Id, order, category_type, and user_id to create a new category. This is an example for category_type as Index.

{
  "name": "New Category",
  "project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
  "order": 0,
  "parent_category_id": null,
  "content": null,
  "category_type": 2,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "content_type": null
}

object

name

string Required

The name of the category

Min length1

project_version_id

string Required

The ID of the project version where category has to be added

Min length1

order

integer (int32)

The position inside the parent category

parent_category_id

string

The ID of the parent category. If empty, it will be added as top level category)

content

string

The content of the article, for any Editor type, use this property

category_type

integer (int32)

0 - Folder, 1 - Page, 2 - Index

Valid values[0,1,2]

user_id

string

The ID of the team account

content_type

integer (int32)

0 - Markdown content; 1 - HTML content; 2 - Block Content

Valid values[0,1,2]

Responses

200

Success

Successfully Created the Category

Here you can find the Category Id and category name to navigate.

{
  "data": {
    "id": "df574e5a-8015-428f-ac33-cad428d1230c",
    "name": "New Category",
    "order": 0,
    "icon": null
  },
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}

Expand All

object

data

object (CategorySimpleData)

string

The ID of the category

name

string

Name of the category

order

integer (int32)

The position inside the parent category

icon

string

Unicode representation of the icon

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError)

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

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

Warning in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

Warning description

warning_code

string

warning code for customer Api base response

information

Array of object (BaseInformation)

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

status description for customer Api response information

400

Bad Request

Invalid Category project_version_id Parameters

Kindly verify the project_version_id, and peroform the task again.

{
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The supplied project version id 46fvf48bc7-760f-4b07-b2d2-fce4aa8ba234 does not exist in your project",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Empty project_version_id Parameters

Kindly verify the project_version_id is not empty, and peroform the task again.

{
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The ProjectVersionId field is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Invalid Category Name Parameter

Kindly verify the Name, and peroform the task again.

{
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The Name field is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

data

object (CategorySimpleData)

string

The ID of the category

name

string

Name of the category

order

integer (int32)

The position inside the parent category

icon

string

Unicode representation of the icon

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError)

Errors in the customer API response

object

extension_data

object (ExtensionDataObject)

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

Warning in the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

Warning description

warning_code

string

warning code for customer Api base response

information

Array of object (BaseInformation)

Information passed by the customer API response

object

extension_data

object (ExtensionDataObject)

description

string

status description for customer Api response information

Was this article helpful?

What's Next

Adds multiple Categories