Bulk delete articles
- 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
Bulk delete articles
- Updated on 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
DELETE /articles/bulkdelete
Deletes list of articles
Header
| Parameter | Type | Description |
|---|---|---|
| api_token | string | You can get the REST API from Settings > Advanced > API tokens. |
Route Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| articleIds | Yes | string[] | IDs of the articles |
Sample Response
The response will show if all articles have been deleted successfully. The details property will include any errors and article title, after issues have been fixed, articles can be resubmitted for further processing.
{
"data":[
{
"success":false,
"details":"Failed to delete article with an id 123aec55-c0a7-42bf-862c-1eea02b96trt"
},
{
"success":true,
"details":"Successfully deleted article with an id 98ehds55-c0a7-42bf-862c-1eea02b96trt"
}
],
"extension_data":null,
"context":null,
"success":true,
"errors":[ ],
"warnings":[ ],
"information":[ ]
}
Response Data (Array[])
| Parameter | Type | Description |
|---|---|---|
| success | boolean | Indicates if article creation was successful |
| details | string | Additional information about article creation status |
Was this article helpful?