Skip to main content
POST
Create a saved search

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
name
string
required

Display name of the saved search

Example:

"VP Engineering in SF"

type
enum<string>
required

Entity type the search targets

Available options:
contacts,
companies
Example:

"contacts"

values
object
required

Search criteria/filters object

sortColumn
string

Column used for sorting results

sortOrder
string

Sort direction

Example:

"desc"

tagIds
integer[]

IDs of lists/tags to associate with the search

numResultsApproved
integer

Number of approved results

Required range: x >= 0
Example:

50

Response

The created saved search

success
boolean
Example:

true

data
object