Python SDK
from revenuebase_sdk import RevenuebaseClient
client = RevenuebaseClient()
job = client.jobs.cancel(process_id=42)
print(job.current_status) # "CANCELLING"curl --request POST \
--url https://api.revenuebase.ai/v2/jobs/{process_id}/cancel \
--header 'x-key: <api-key>'const options = {method: 'POST', headers: {'x-key': '<api-key>'}};
fetch('https://api.revenuebase.ai/v2/jobs/{process_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.revenuebase.ai/v2/jobs/{process_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.revenuebase.ai/v2/jobs/{process_id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.revenuebase.ai/v2/jobs/{process_id}/cancel")
.header("x-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revenuebase.ai/v2/jobs/{process_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"process_id": 123,
"filename": "<string>",
"current_status": "<string>",
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Utilities
Cancel a batch job
Ask an email verification batch to stop processing.
POST
/
v2
/
jobs
/
{process_id}
/
cancel
Python SDK
from revenuebase_sdk import RevenuebaseClient
client = RevenuebaseClient()
job = client.jobs.cancel(process_id=42)
print(job.current_status) # "CANCELLING"curl --request POST \
--url https://api.revenuebase.ai/v2/jobs/{process_id}/cancel \
--header 'x-key: <api-key>'const options = {method: 'POST', headers: {'x-key': '<api-key>'}};
fetch('https://api.revenuebase.ai/v2/jobs/{process_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.revenuebase.ai/v2/jobs/{process_id}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.revenuebase.ai/v2/jobs/{process_id}/cancel"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.revenuebase.ai/v2/jobs/{process_id}/cancel")
.header("x-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revenuebase.ai/v2/jobs/{process_id}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"process_id": 123,
"filename": "<string>",
"current_status": "<string>",
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Credits and plans
PAYG is Pay-as-you-go. AYCE is All-you-can-eat.| Usage | PAYG | AYCE |
|---|---|---|
| This request | Free 0 credits | Free 0 credits |
exportId and their own export status endpoints.
When to use this endpoint
Cancel a queued or running job when you no longer need the remaining checks. Cancellation adds no credit charge. Results already verified as Valid or Invalid remain billable.Example
SetREVENUEBASE_PROCESS_ID to the process_id returned by your batch upload.
Set REVENUEBASE_API_KEY to your API key.
curl --request POST "https://api.revenuebase.ai/v2/jobs/$REVENUEBASE_PROCESS_ID/cancel" \
--header "X-Key: $REVENUEBASE_API_KEY"
What happens next
The response usescurrent_status: "CANCELLING". A queued job will not process its list. A running job may finish its current work before stopping, so cancellation is not immediate.
Poll status until CANCELLED or another terminal state. Partial output can be available for a job that processed some rows. A completed job cannot be cancelled to refund its verification.
Errors and retries
Already CANCELLING or CANCELLED jobs return 400, as do COMPLETED or ERROR jobs and jobs outside your account. Re-read current_status before repeating a request; an already accepted cancellation does not need another POST.Next steps
Check job status, then download available results.Was this page helpful?
