Update Saved Search

Rename a saved search or switch its alert.

PATCHhttps://api.foxreach.io/api/v1/lead-finder/saved-searches/{saved_search_id}

Requires an API key with the write scope.

Path Parameters#

saved_search_idstringpathrequired

The saved search id.

Body Parameters#

namestringbody

New name, 1 to 200 characters.

alertEnabledbooleanbody

Switch the new-results alert on or off.

Response#

dataobject

Show data

idstring

Saved search identifier.

namestring

Name.

kindstring

people or companies.

filtersobject

The stored filter object.

lastRunAtstring

ISO 8601 timestamp of the last run, or null.

lastTotalinteger

Result count from the last run, or null.

alertEnabledboolean

Whether alerts are on for this search.

createdAtstring

ISO 8601 timestamp.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `write`
`404`	`Lead Finder is not enabled` while Lead Finder is switched off on this environment
`503`	`Lead Finder is not configured` when it is enabled but has no data provider key
`404`	`Saved search not found`: it does not exist in this workspace

Rate Limit#

120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl -X PATCH "https://api.foxreach.io/api/v1/lead-finder/saved-searches/ss_abc123" \
  -H "X-API-Key: otr_your_key" \
  -H "Content-Type: application/json" \
  -d '{"alertEnabled": true}'

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
client.lead_finder.update_saved_search("ss_abc123", alert_enabled=True)

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
await client.leadFinder.updateSavedSearch("ss_abc123", { alertEnabled: true });

Response

JSON

{
  "data": {"id": "ss_abc123", "name": "CTOs in Berlin", "kind": "people", "filters": {"jobTitles": ["CTO"]}, "lastRunAt": null, "lastTotal": null, "alertEnabled": false, "createdAt": "2026-11-04T10:00:00+00:00"}
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026