Collections
...
Collections API
Requests
Clear Requests
4min
All of the Requests in a collection can be cleared by making an HTTP DELETE request to the /collections/COLLECTION_ID/clear endpoint (where COLLECTION_ID is the id of the Collection).
Collection Status Collections can only be cleared from a Collection when it is not running. To check whether a Collection is currently running use the Get Collection endpoint.
DELETE /collections/COLLECTION_ID/clear
In the example below we clear a Collection with id=123456 :
Curl
Node.js
Python
PHP
1$ curl -X DELETE "https://api.redcircleapi.com/collections/123456/clear?api_key=demo"
RedCircle API responds with a JSON object confirming that the collection has been cleared:
JSON
{...}
"request_info":{...}
"success":true,
"message":"Collection requests cleared",
Next Steps Update Request List Request
Updated 08 Aug 2024
Did this page help you?