Collections
...
Collections API
Requests

Update Request

4min

Update Request

Requests within a Collection can be updated by making an HTTP PUT to the /collections/COLLECTION_ID/REQUEST_ID endpoint (where REQUEST_ID is the id of the Request and COLLECTION_ID is the id of the Collection the Request belongs to). The body can be either x-www-form-urlencoded parameters or a JSON object.

The parameters for updating a Request are the same as those used when making a call via the Product Data API.

Collection Status Requests can only be updated when the Collection they belong to is not running. To check whether a Collection is currently running use the Get Collection endpoint.

Updating Multiple Requests You should make calls to the Update Request endpoint sequentially, rather than in parallel, as it is designed to update Requests one by one. If you make too many concurrent calls you will receive an HTTP 429 error. For mass-update operations consider deleting and re-creating the Collection as this is typically quicker.



Example

PUT /collections/COLLECTION_ID/REQUEST_ID

In the example below we update a Request with id=ABCDEFGHIJKLMNOP within a Collection with id=123456 .

Curl
Node.js
Python
PHP


Rainforest API responds with a JSON object containing details of the Request fields that have been updated:

JSON



Next Steps      Delete Requests      List Requests