Fork category page with an id

Updated on Dec 24, 2024

4 minute(s) read

Anand Murali

Prev Next

Put

/v2/Categories/{categoryId}/fork

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

ID of the category

Body parameters

Fork category page with Id

Fork category page with current version_number, user_id and lang_code.

{
  "version_number": 1,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "lang_code": "en"
}

object

version_number

integer (int32) Required

The version number of the category page

user_id

string Required

The ID of the team account

Min length1

lang_code

string Required

Language code of the category

Min length1

Fork category page with Id

Fork category page with current version_number, user_id and lang_code.

{
  "version_number": 1,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "lang_code": "en"
}

object

version_number

integer (int32) Required

The version number of the category page

user_id

string Required

The ID of the team account

Min length1

lang_code

string Required

Language code of the category

Min length1

Fork category page with Id

Fork category page with current version_number, user_id and lang_code.

{
  "version_number": 1,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "lang_code": "en"
}

object

version_number

integer (int32) Required

The version number of the category page

user_id

string Required

The ID of the team account

Min length1

lang_code

string Required

Language code of the category

Min length1

Fork category page with Id

Fork category page with current version_number, user_id and lang_code.

{
  "version_number": 1,
  "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
  "lang_code": "en"
}

object

version_number

integer (int32) Required

The version number of the category page

user_id

string Required

The ID of the team account

Min length1

lang_code

string Required

Language code of the category

Min length1

Responses

200

Success

Fork category page with Id

Fork category page with current version_number, user_id and lang_code.

{
  "data": {
    "version_number": 2,
    "created_by": "peter jone",
    "created_at": "2024-06-13T14:30:00Z",
    "modified_at": "2024-06-13T14:30:00Z",
    "base_version": 1,
    "status": 0,
    "profile_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E"
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

data

object | null

category response forked data

version_number

integer (int32)

The currently fetched version number of this category page

created_by

string | null

The ID of the user that created the category page

created_at

string (date-time)

The date the category page was created

modified_at

string (date-time)

The date the category page was last modified

base_version

integer (int32)

The base version of the currently fetched category page

status

integer (int32)

The status of the article: 0 - Draft, 3 - Published

Valid values[ 0, 3 ]

profile_url

string | null

The URL of team account's profile image

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

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

Extention Data for customer Api warning

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

Extention data for customer Api response information

description

string | null

status description for customer Api response information

400

Bad Request

Category not found

Category page not found in the context. Kindly verify the categoryId and perform the task again.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Category not found",
      "error_code": "",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

UserId not found

UserId not found in the context. Kindly verify the categoryId and perform the task again.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The user with id 'f11efc6f-e968-4e95-82eb-85ad61559de' does not exist in your project.",
      "error_code": "",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Version Number not found

Version Number not found in the context. Kindly verify the categoryId and perform the task again.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Cannot fork version number 5, it does not exist in your project",
      "error_code": "",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

LangCode not found

LangCode is missing in the Request Body. Kindly verify the categoryId and perform the task again.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The LangCode field is required.",
      "error_code": "",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

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

Extention Data for customer Api warning

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

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?