Searches

Update search

put/searches/{id}

Request

  • Base URL: https://api.pipelinecrm.com/api/v3
  • URL: https://api.pipelinecrm.com/api/v3/searches/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header app-key
    • API key in query parameter api_key and API key in query parameter app_key

Path parameters

idinteger required

Search ID

Request body

Example request

{
  "search": {
    "name": "Renewals closing this quarter",
    "search_type": "deals",
    "query": {
      "person_name": "James",
      "person_email": "@acme.com"
    },
    "columns": [
      "person_name",
      "person_email"
    ]
  }
}

Response

Successful Response

idinteger

ID of the search

search_type'people' | 'deals' | 'companies' | 'activities'

The type of record this search runs on

is_defaultboolean

Whether or not this search is provided by default

is_starredboolean

Whether or not this search is starred

is_sharedboolean

Whether or not this search is shared with other users

user_idinteger

The ID of the user who created this search

sortstring

Sort order and column for search results.

namestring

This search's human-readable name

queryobject

The search query, mapping column identifiers to the string value being searched for

columnsstring[]

The list view columns / search result attributes this search displays and returns

Example response

{
  "id": 1,
  "search_type": "deals",
  "user_id": 13,
  "sort": "-people.updated_at",
  "name": "Renewals closing this quarter",
  "query": {
    "person_name": "James",
    "person_email": "@acme.com"
  },
  "columns": [
    "person_name",
    "person_email"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.