Update Collection

3min

Update Collection
Collections can be updated by making an HTTP PUT to the /collections/COLLECTION_ID endpoint (where COLLECTION_ID is the id of the Collection). The body can be either x-www-form-urlencoded parameters or a JSON object.
The parameters  for updating a Collection are the same as those used when creating a Collection.
﻿
Example
﻿PUT  /collections/COLLECTION_ID
In the example below we update a Collection with id=123456 to run weekly, on Monday at 8am:
Curl
Node.js
Python
PHP
$ curl -X PUT "https://api.bigboxapi.com/collections/123456?api_key=demo" \
  -d schedule_type="weekly" \
  -d schedule_days_of_week="1" \
  -d schedule_hours="8"
$ curl -X PUT "https://api.bigboxapi.com/collections/123456?api_key=demo" \
  -d schedule_type="weekly" \
  -d schedule_days_of_week="1" \
  -d schedule_hours="8"
﻿
BigBox API responds with a JSON object containing details of the updated Collection.
A Collection can only be updated when it is not running. To check whether a Collection is currently running use the Get Collection endpoint.
﻿
Next Steps
     Start Collection
     Get Collection﻿

Updated 07 Aug 2024

Did this page help you?

Create Collection

Start Collection