Document360 Customer API

Update multiple page categories

23 May 2024
7 Minutes to read
Contributors

Print
Share
Dark
Light
PDF

Update multiple page categories

Updated on 23 May 2024
7 Minutes to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Put

/v2/Categories/bulkupdateContent

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

Update multiple page category

Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.

[
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6",
    "lang_code": "en",
    "title": "New Name",
    "content": "No new content",
    "html_content": "No new content",
    "block_content": "No new content",
    "version_number": 2,
    "translation_option": null,
    "source": null,
    "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8"
  }
]

Array of object

object

Update category content

category_id

string | null

Category ID for updating the content

lang_code

string | null

Language Code for updating the content

title

string | null

The title of the category

content

string | null

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

html_content

string | null Deprecated

The HTML content of the category. If the editor type is WYSIWYG (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

block_content

string | null Deprecated

The HTML content of the category. If the editor type is Block Editor (HTML), use this property - (This property is deprecated and will be removed in a future version of the API, Kindly use content property instead of this.)

version_number

integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option

string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source

string | null

Free text used for future reference

updated_by

string | null

The ID of the team account responsible for the category update

Update multiple page category

Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.

[
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6",
    "lang_code": "en",
    "title": "New Name",
    "content": "No new content",
    "html_content": "No new content",
    "block_content": "No new content",
    "version_number": 2,
    "translation_option": null,
    "source": null,
    "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8"
  }
]

Array of object

object

Update category content

category_id

string | null

Category ID for updating the content

lang_code

string | null

Language Code for updating the content

title

string | null

The title of the category

content

string | null

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

html_content

string | null Deprecated

block_content

string | null Deprecated

version_number

integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option

string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source

string | null

Free text used for future reference

updated_by

string | null

The ID of the team account responsible for the category update

Update multiple page category

Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.

[
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6",
    "lang_code": "en",
    "title": "New Name",
    "content": "No new content",
    "html_content": "No new content",
    "block_content": "No new content",
    "version_number": 2,
    "translation_option": null,
    "source": null,
    "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8"
  }
]

Array of object

object

Update category content

category_id

string | null

Category ID for updating the content

lang_code

string | null

Language Code for updating the content

title

string | null

The title of the category

content

string | null

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

html_content

string | null Deprecated

block_content

string | null Deprecated

version_number

integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option

string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source

string | null

Free text used for future reference

updated_by

string | null

The ID of the team account responsible for the category update

Update multiple page category

Update multiple page category. Kindly for the needed page category for the bulk updation. you can find the updated_by (user id) from /V2/Teams Get Method.

[
  {
    "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6",
    "lang_code": "en",
    "title": "New Name",
    "content": "No new content",
    "html_content": "No new content",
    "block_content": "No new content",
    "version_number": 2,
    "translation_option": null,
    "source": null,
    "updated_by": "f11efc6f-e968-4e95-82eb-85ad61559de8"
  }
]

Array of object

object

Update category content

category_id

string | null

Category ID for updating the content

lang_code

string | null

Language Code for updating the content

title

string | null

The title of the category

content

string | null

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

html_content

string | null Deprecated

block_content

string | null Deprecated

version_number

integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option

string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source

string | null

Free text used for future reference

updated_by

string | null

The ID of the team account responsible for the category update

Responses

200

Success

Bulk Update Successful

You can find all the updated Category page details below.

{
  "data": [
    {
      "category_id": "152e9239-1a5a-4044-b5de-1030f49976b6",
      "success": true,
      "details": "Successfully updated category with an id 152e9239-1a5a-4044-b5de-1030f49976b6"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Array of object

object

Update category content

category_id

string | null

Category ID for updating the content

lang_code

string | null

Language Code for updating the content

title

string | null

The title of the category

content

string | null

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

html_content

string | null Deprecated

block_content

string | null Deprecated

version_number

integer (int32) | null

The version number of the category to be updated. The latest version is updated by default.

translation_option

string | null

Translation status of the category. 0 - None, 1 - Needs translation, 2 Translated

source

string | null

Free text used for future reference

updated_by

string | null

The ID of the team account responsible for the category update

400

Bad Request

Category not Found

The enhtered categoryId is not valid. Kindly verify the categoryId and perform the task again.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Failed to update category with an id 152e9239-1a5a-044-b5de-103f49976b6\r\nError: Category not found' does not exist in your project.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

UserId not Found

The user_id is not found. kindly verify the updated_by (user id) from /V2/Teams Get Method

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Failed to update category with an id 152e9239-1a5a-4044-b5de-1030f49976b6\r\nError: The user with id '6f-e968-4e95-82eb-85ad61559de8' does not exist in your project.",
      "error_code": null,
      "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

Was this article helpful?

What's Next

Fork category page with an id