API reference / Email verification

Stop a verification job

Written and maintained by The ProspectAPIs team

POST/v1/email/verify/jobs/:id/stop

POST /v1/email/verify/jobs/:id/stop is the ProspectAPIs operation emailVerifyJobStop, in the Email verification group of the REST API. Turns off a job's monitoring; a job still running is cancelled and what it checked stays readable. Free. Cost: free. Send your API key as a Bearer token in the Authorization header.

How this fits with the rest of the email verification API, with worked examples, is in the email verification guide.

Parameters

Responses

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens.

200 response fields

The job.

The spec declares no fields for this response.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl -X POST https://api.prospectapis.com/v1/email/verify/jobs/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/stop \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"

const res = await fetch("https://api.prospectapis.com/v1/email/verify/jobs/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/stop", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.post(
    "https://api.prospectapis.com/v1/email/verify/jobs/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/stop",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

This call is free: it never spends credits, so you can call it as often as the rate limit allows. Metered calls on the same key report your balance after each response in X-Credits-Remaining, and GET /v1/account shows it at any time.

Related

The email verification guide covers this area end to end. Previous operation: Get a job's results. Next operation: List watchlists. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values (this call acts for real, so use real inputs).