Collections
...
Collections API
Collections
Delete Collection
4min
Collections can be deleted by making an HTTP DELETE request to the /collections/COLLECTION_ID endpoint (where COLLECTION_ID is the id of the Collection you wish to delete).
A Collection can only be deleted when it is not running. To check whether a Collection is currently running use the Get Collection endpoint.
DELETE /collections/COLLECTION_ID
In the example below we delete a Collections with id=123456 :
Curl
Node.js
Python
PHP
1$ curl -X DELETE "https://api.bigboxapi.com/collections/123456?api_key=demo"
BigBox API responds with a JSON object confirming that the Collection has been deleted, or detailing the error if it has not been possible to delete the Collection:
JSON
{...}
"request_info":{...}
"success":true,
"message":"collection deleted",
Next Steps Get Collections List Collections
Updated 07 Aug 2024
Did this page help you?