Batches
...
Batches API
Batches

Update Batch

3min

Update Batch

Batches can be updated by making an HTTP PUT to the /batches/BATCH_ID endpoint (where BATCH_ID is the id of the Batch). The body can be either x-www-form-urlencoded parameters or a JSON object.

The parameters for updating a Batch are the same as those used when creating a Batch.



Example

PUT /batches/BATCH_ID

In the example below we update a Batch with id=123456 to run weekly, on Monday at 8am:

Curl
Node.js
Python
PHP


VALUE SERP responds with a JSON object containing details of the updated Batch.

A Batch can only be updated when it is not running. To check whether a Batch is currently running use the Get Batch endpoint.



Next Steps      Start Batch      Get Batch

Updated 13 Aug 2024
Did this page help you?