Skip to main content
POST
Create a saved search

Authorizations

Authorization
string
header
required

Your API token (af_…) as the Basic-auth username, with an empty password.

Body

application/json

A title plus filters written in the vocabulary of type (people by default); the search then opens identically in the product UI.

title
string
required

Display name of the saved search (1-255 chars); need not be unique, but a shared title cannot be referenced as savedSearchName later.

Required string length: 1 - 255
type
enum<string>
default:people

Kind of search the filters describe: people (default) or company; immutable after creation.

Available options:
people,
company
filters
object

Filters in the vocabulary of type: people filters as POST /prospects/search takes them (first_name / last_name cannot be stored and answer 422 SAVED_SEARCH_FILTERS_UNSUPPORTED), company filters as POST /companies/search takes them; at least one non-empty value either way.

Response

Success