Adds multiple Categories

  • Updated on Sep 2, 2024
  • 9 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
Post
/v2/Categories/bulkcreate
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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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
  }
]
Array of object
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 | null

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

content
string | null

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

The ID of the team account

content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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
  }
]
Array of object
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 | null

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

content
string | null

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

The ID of the team account

content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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
  }
]
Array of object
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 | null

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

content
string | null

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

The ID of the team account

content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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 1",
    "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
  },
  {
    "name": "New Category 2",
    "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
  }
]
Array of object
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 | null

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

content
string | null

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

The ID of the team account

content_type
integer (int32)

0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG

Valid values[ 0, 1, 2 ]
Responses
200

Success

Update article wth article Id

Update the article with needed information such as title, content, html_content, category_id, hidden, version_number, translation_option, and source.

{
  "data": [
    {
      "category_id": "b1a857d9-ecbc-4ab3-a0cb-ed22267ec999",
      "success": true,
      "details": "Successfully created category New Category 1"
    },
    {
      "category_id": "975a72df-a8b6-4a4e-8081-be9baddd0467",
      "success": true,
      "details": "Successfully created category New Category 2"
    }
  ],
  "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 (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

No Category created

Kindly add some data to create category.

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

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

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

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