Collections
...
Collections API
Collections

Start Collection

3min

Start Collection

Collections can be started by making an HTTP GET request to the /collections/COLLECTION_ID/start endpoint (where COLLECTION_ID is the id of the Collection). You must have sufficient request credits available on your account for the number of requests in the Collection.

You would typically start Collections that are set to schedule_type=manual but you can start a Collection with any schedule_type , just as long as it isn't currently running.



Example

GET /collections/COLLECTION_ID/start

In the example below we start a Collection with id=123456 :

HTTP
Curl
Node.js
Python
PHP


BigBox API responds with a JSON object confirming that the Collection has been started, or detailing the error if it has not been possible to start the Collection (i.e. there are insufficient request credits available on your account).



Next Steps      Get Collections      List Collections