API reference / Watchlists
Resume a paused watchlist
Written and maintained by The ProspectAPIs team
POST/v1/watchlists/:id/resume
POST /v1/watchlists/:id/resume is the ProspectAPIs operation resumeWatchlist, in the Watchlists group of the REST API. Switch a watchlist back on after it paused itself for repeated webhook failures (paused_reason "webhook failed N times in a row"), keeping its id and delivery history. Free. A watchlist paused for another reason (a revoked key, filters no longer valid) answers 409 not_resumable; an active one answers resumed: false, reason not_paused. Cost: free. Send your API key as a Bearer token in the Authorization header.
How this fits with the rest of the watchlists API, with worked examples, is in the watchlists guide.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| id required | path | string (uuid) | A UUID. |
| Idempotency-Key | header | string | Optional, 1 to 255 printable ASCII characters. A retry with the same key and body within 24 hours gets the first answer back with Idempotent-Replayed: true and is never charged again. The same key with a different body is 422; a retry while the first call is still running is 409. |
Responses
| Status | Meaning |
|---|---|
| 200 | resumed true, or resumed false with reason not_paused; watchlist is the watchlist as it is now. |
| 401 | The API key is missing or invalid. |
| 404 | No such record for this account. |
| 409 | not_resumable: the watchlist was paused for a reason other than repeated webhook failures (paused_reason says which), or the API key that created it has been revoked since (blocked_by: api_key_revoked). |
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
resumed true, or resumed false with reason not_paused; watchlist is the watchlist as it is now.
| Field | Type | Description |
|---|---|---|
| resumed required | boolean | |
| reason | string: not_paused | |
| watchlist required | object |
| Header | Meaning |
|---|---|
| RateLimit-Limit | Requests this API key may make per minute. |
| RateLimit-Remaining | Requests left in the current one-minute window. |
| RateLimit-Reset | Seconds until the current window resets. |
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/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/resume \
-H "Authorization: Bearer $PROSPECTAPIS_KEY"const res = await fetch("https://api.prospectapis.com/v1/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/resume", {
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/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/resume",
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 watchlists guide covers this area end to end. Previous operation: Send a test delivery. Next operation: List recent deliveries. 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).
Was this page helpful?