Skip to main content
POST
/
batch-lookups
/
{job_id}
/
cancel
Cancel Batch Job
curl --request POST \
  --url https://api.incentives.leap.energy/alpha/batch-lookups/{job_id}/cancel \
  --header 'x-api-key: <api-key>'
{
  "message": "Job cancelled successfully",
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

​
Overview

Cancel a batch job to stop processing. Pending items are marked as failed with “Job cancelled”; items already in progress are allowed to complete. Cancelled jobs cannot be resumed.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Include your Leap API key in the x-api-key header: x-api-key: leap_live_...

Path Parameters

​
job_id
string<uuid>
required

Response

Job cancelled successfully

​
message
string
Example:

"Job cancelled successfully"

​
job_id
string<uuid>