Deletes multiple articles
- 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Deletes multiple articles
- Updated On 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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": []
}object
data
Array of object (BulkArticleResultCustomer) | null
Bulk delete article response
object
article_id
string | null
Article ID that has updated
success
boolean
Indicates if articles creation was successful
details
string | null
Additional information about articles creation status
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
Article Id not found
Kindly verify the article Id and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Failed to delete article with an id 4b10a0b0-7300-4f0d-b2cd-47c619af4047\r\nError: Article not found",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}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?
