Skip to main content
PUT
Update a saved search

Authorizations

Authorization
string
header
required

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

Scopes

publicAPI.v2.all

Public API v2

Path Parameters

id
integer
required

Unique identifier of the saved search

Example:

789

Body

application/json
name
string

New display name of the saved search.

values
object

Search filters, under the same names POST /search/contacts and POST /search/companies accept, matching the saved search type. Filters the search endpoints do not accept are stored as sent and ignored when the search runs. A location that matches no known place is rejected. Intent filters are dropped.

sortColumn
string

Column used to sort results. Stored as sent.

sortOrder
string

Sort direction. Stored as sent.

Example:

"desc"

tagIds
integer[]

IDs of lists to link, replacing the current links. Numeric strings are accepted. An empty array leaves the links unchanged.

numResultsApproved
integer

Result count to store. Stored as sent; the search is not re-run.

Required range: x >= 0

Response

The updated saved search.

success
boolean
Example:

true

data
object