Fork category page with an id

Prev Next
Put
/v2/Categories/{categoryId}/fork
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

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

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

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

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.