Cancel a Batch Job

If you need to change a batch job, you can cancel the first one and then create a new one. Cancelling a batch job you don't need will also speed up the queue for everyone, including any jobs you create later. Once a batch job is complete and you no longer need the results, you can use this API to purge the results from the system earlier than they would be automatically.

On This Page...

API Request

API Endpoints

HTTP Verbs and URIs

DELETE /v2/jobs/{jobId}
  • Cancel a batch job with the matching job ID..

Parameters

Parameter Description Valid Values
{jobId} The ID of the job that was returned when you created it. Integer ID as supplied by aWhere

Query String Parameters

No query string parameters are supported.

Request Body

None

HTTP Headers

Remember to always send your OAuth2 Access Token in the Authorization header (see Authentication). This API doesn't require any additional headers.

API Response

Response HTTP Status Codes and Headers

This API returns standard HTTP status codes and headers for aWhere APIs. No additional headers are returned. When a job is successfully cancelled, the status code will be 204 No Content.

Response Body

None.