Bulk delete articles
  • Updated on 07 Aug 2019
  • 1 minute to read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Bulk delete articles

  • Print
  • Share
  • Dark
    Light

DELETE/articles/bulkdelete

Deletes list of articles


Header

Parameter Type Description
api_token string REST API key you can get it from Settings > API.

Route Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
articleIds string[] IDs of the articles

Sample Response

The response will show if all articles have been deleted succesfully. The details property will include any errors and article title, after issues have been be 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?