Contents x
    Deletes multiple articles
    • 25 Nov 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Deletes multiple articles

    • Updated on 25 Nov 2023
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    Article Summary

    Delete
    /v2/Articles/bulkdelete
    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
    articleIds
    array of stringRequired

    Array of article IDs

    Responses
    200

    Success

    Successfully deleted bulk article

    This states that the bulk article has been deleted successfully.

    {
  "data": [
    {
      "article_id": null,
      "success": true,
      "details": "Successfully deleted article with an id 4b10a0b0-7300-4f0d-b2cd-47c619af4047"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    Array of object (BulkArticleResultCustomer)

    Bulk delete article response

    object
    article_id
    string

    Article ID that has updated

    success
    boolean

    Indicates if articles creation was successful

    details
    string

    Additional information about articles creation status

    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api response

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    400

    Bad Request

    Article Id not found

    Kindly verify the article Id and perform the task again.

    {
  "data": [
    {
      "article_id": null,
      "success": false,
      "details": "Failed to delete article with an id 4b10a0b0-7300-4f0d-b2cd-47c619af4047\r\nError: Article not found"
    }
  ],
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
    Expand All
    object
    data
    Array of object (BulkArticleResultCustomer)

    Bulk delete article response

    object
    article_id
    string

    Article ID that has updated

    success
    boolean

    Indicates if articles creation was successful

    details
    string

    Additional information about articles creation status

    extension_data
    object (ExtensionDataObject)
    success
    boolean

    Status indication for customer API response

    errors
    Array of object (BaseError)

    Errors in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    stack_trace
    string

    Stack trace for error response message

    description
    string

    Description for error cause

    error_code
    string

    Error code for Api response

    custom_data
    object
    warnings
    Array of object (BaseWarning)

    Warning in the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    Warning description

    warning_code
    string

    warning code for customer Api base response

    information
    Array of object (BaseInformation)

    Information passed by the customer API response

    object
    extension_data
    object (ExtensionDataObject)
    description
    string

    status description for customer Api response information

    Was this article helpful?
    What's Next