Rename a saved search or replace its filters
Rename a saved search, replace its filters, or both — at least one of title and filters is required. A search's type is immutable, so filters must speak the stored search's own language: the keys POST /prospects/search takes for a people search, the keys POST /companies/search takes for a company one. The replacement is wholesale, not a merge.
filters is validated against the stored type after the row is loaded, so a rejected body answers 422 VALIDATION_FAILED with param naming the offending key — never SAVED_SEARCH_INVALID, which is reserved for a stored search that has itself gone stale. Keys that do not exist in the stored search's vocabulary are ignored rather than named, so filters sent in the wrong vocabulary are reported as "filters must contain at least one non-empty value"; check searchType first. The only two people filter fields that cannot round-trip through the product's filter rail are first_name and last_name; either one answers 422 SAVED_SEARCH_FILTERS_UNSUPPORTED naming the field.
Errors:
- 404 SAVED_SEARCH_NOT_FOUND — No saved search of yours has that id.
- 422 VALIDATION_FAILED — The request failed the declared schema; param names the offending key and message quotes the rule it broke.
- 422 SAVED_SEARCH_FILTERS_UNSUPPORTED — filters names first_name or last_name — the only two people filter fields with no saved-search equivalent; param names the field.
- 429 RATE_LIMITED — Per-token rate limit for this bucket exhausted; retry after the window in the RateLimit-Reset header.
- 500 UNEXPECTED_ERROR — The request failed inside the service; nothing was billed and the request_id identifies the failure.
Requires one of the following token scopes: search.
Request
- Base URL: https://api.tryfuse.ai/api/v1
- URL: https://api.tryfuse.ai/api/v1/business/saved-searches/{savedSearchId}
- Auth: HTTP basic
Path parameters
Id of the saved search (24-character hex ObjectId), as returned by GET /saved-searches.
Request body
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.