Contents x
Delete multiple article versions
  • 16 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Delete multiple article versions

  • Updated on 16 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
Delete
/v2/Articles/bulkdelete-article-versions
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Query parameters
articleId
string Required

The ID of the article

langCode
string Required

Language code of the article

articleVersionNumbers
array of integer Required

Array of article version numbers

Responses
200

Success

Articles Deleted Successfully

Article has been successfully deleted. This file cannot be retrived or undo.

{
  "article_id": "00966e87-2f6c-4844-b586-ccc81ddab056",
  "data": "Deleted article version(s) are 1,2,3",
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": [],
  "information": []
}
Expand All
object
article_id
string

IDs of the articles

data
string

Response article data

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
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

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

400

Bad Request

Article not found

Kindly verify your articleId and perform the task again. Also verify the langCode (language code) is mismatching.

{
  "article_id": null,
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Article not found",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Article Version not found

Kindly verify your articleVersion and perform the task again. Also verify the langCode (language code) is mismatching.

{
  "article_id": null,
  "data": null,
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Invalid Article Version",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
article_id
string

IDs of the articles

data
string

Response article data

extension_data
object
success
boolean

Status indication for customer Api response

errors
Array of object

Errors in the customer Api response

object
extension_data
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

Warning in the customer Api response

object
extension_data
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object

Information passed by the customer Api response

object
extension_data
description
string

status description for customer Api response information

Was this article helpful?
What's Next