Saved Searches

Update Saved Search

Changed on

Change a saved search's name, filters, type or email alert. Only the fields you send change. New filters also change what any webhook on this saved search delivers from then on. The saved search of a sales signal is refused; change its filters from the signal.

patch/v0/saved_searches/{search_id}

Request

  • Base URL
    https://api.theirstack.com
  • URL
    https://api.theirstack.com/v0/saved_searches/{search_id}
  • Auth
    HTTP bearer

Path parameters

search_idinteger required

The ID of the saved search

Request body

namestring nullable

Name of the saved search

type'companies' | 'jobs'
is_alert_activeboolean nullable

Email new results to the creator of the saved search. Alerts only go to the creator.

frequency'daily' | 'weekly' nullable

How often the alert email is sent.

Example request

{
  "body": {
    "order_by": [
      {
        "field": "relevance"
      }
    ],
    "company_name_or": [],
    "company_name_case_insensitive_or": [],
    "company_id_or": [],
    "company_id_not": [],
    "company_domain_or": [],
    "company_domain_not": [],
    "company_name_not": [],
    "company_name_partial_match_or": [],
    "company_name_partial_match_not": [],
    "company_linkedin_url_or": [],
    "property_exists_or": [],
    "property_exists_and": [],
    "limit": 25,
    "job_filters": {
      "job_title_or": [],
      "job_title_not": [],
      "job_title_pattern_and": [],
      "job_title_pattern_or": [],
      "job_title_pattern_not": [],
      "job_country_code_or": [],
      "job_country_code_not": [],
      "job_description_pattern_or": [],
      "job_description_pattern_not": [],
      "job_description_pattern_and": [],
      "job_description_contains_or": [],
      "job_description_contains_not": [],
      "job_description_pattern_case_sensitive_or": [],
      "workplace_types_or": [],
      "job_id_or": [],
      "job_id_not": [],
      "job_seniority_or": [],
      "job_location_pattern_or": [],
      "job_location_pattern_not": [],
      "job_location_or": [],
      "job_location_not": [],
      "url_domain_or": [],
      "url_domain_not": [],
      "employment_statuses_or": [],
      "property_exists_or": [],
      "property_exists_and": []
    }
  }
}

Response

Successful Response

idinteger required

ID of the saved search

namestring required

Name of the saved search

type'companies' | 'jobs' required
is_alert_activeboolean

Is the alert active

user_idinteger required

Owner of the saved search

team_idinteger required

Team of the saved search

created_atstring date-time required

Date and time when the saved search was created

updated_atstring date-time required

Date and time when the saved search was last updated

querystring nullable

Query of the request

pathstring nullable

Path of the request

querystring_paramsobject nullable

Dictionary containing the querystring parameters of the request.

is_archivedboolean

Is the saved search archived

has_active_webhooksboolean

Has active webhooks

origin'manual' | 'signal'
frequency'daily' | 'weekly'
emails_subscribedstring[] nullable

The creator's email, recorded when the saved search was created. Alerts are sent to the creator.

Example response

{
  "body": {
    "order_by": [
      {
        "field": "relevance"
      }
    ],
    "company_name_or": [],
    "company_name_case_insensitive_or": [],
    "company_id_or": [],
    "company_id_not": [],
    "company_domain_or": [],
    "company_domain_not": [],
    "company_name_not": [],
    "company_name_partial_match_or": [],
    "company_name_partial_match_not": [],
    "company_linkedin_url_or": [],
    "property_exists_or": [],
    "property_exists_and": [],
    "limit": 25,
    "job_filters": {
      "job_title_or": [],
      "job_title_not": [],
      "job_title_pattern_and": [],
      "job_title_pattern_or": [],
      "job_title_pattern_not": [],
      "job_country_code_or": [],
      "job_country_code_not": [],
      "job_description_pattern_or": [],
      "job_description_pattern_not": [],
      "job_description_pattern_and": [],
      "job_description_contains_or": [],
      "job_description_contains_not": [],
      "job_description_pattern_case_sensitive_or": [],
      "workplace_types_or": [],
      "job_id_or": [],
      "job_id_not": [],
      "job_seniority_or": [],
      "job_location_pattern_or": [],
      "job_location_pattern_not": [],
      "job_location_or": [],
      "job_location_not": [],
      "url_domain_or": [],
      "url_domain_not": [],
      "employment_statuses_or": [],
      "property_exists_or": [],
      "property_exists_and": []
    }
  }
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      request property // reactivated

    • info

      request property // reactivated

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      response property body/anyOf[subschema #1: CompanySearchFilters]/revealed_company_data reactivated

    • info

      response property body/anyOf[subschema #2: JobSearchFilters]/revealed_company_data reactivated