Skip to main content
PATCH
/
v1
/
searches
/
{id}
curl -X PATCH "https://api.trigify.io/v1/searches/search_abc123xyz" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Search Name",
    "status": "paused",
    "filters": {
      "time_frame": "past-month",
      "frequency": "WEEKLY",
      "max_results": 200,
      "job_titles": ["CEO", "CTO", "VP of Engineering"]
    }
  }'

{
  "message": "<string>",
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "status": "active",
    "created_at": "<string>",
    "last_result_at": "<string>",
    "total_results": 123,
    "query": {
      "keywords": [
        "<string>"
      ],
      "monitoring_type": "<string>",
      "keywords_and": [
        "<string>"
      ],
      "keywords_not": [
        "<string>"
      ]
    },
    "updated_at": "<string>",
    "filters": {
      "time_frame": "<string>",
      "max_results": 123,
      "frequency": "<string>",
      "job_titles": [
        "<string>"
      ]
    }
  }
}
Update an existing search’s configuration, including name, status, and filters.

​
Overview

The Update Search endpoint allows you to modify a search’s settings without recreating it. You can pause/resume searches, change filters, or update the name.

​
Authentication

Requires a valid API key with the searches:write permission.

​
Key Features

  • Partial Updates: Only send the fields you want to change
  • Pause/Resume: Toggle search status without deleting
  • No Credit Cost: Updates are free
curl -X PATCH "https://api.trigify.io/v1/searches/search_abc123xyz" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Search Name",
    "status": "paused",
    "filters": {
      "time_frame": "past-month",
      "frequency": "WEEKLY",
      "max_results": 200,
      "job_titles": ["CEO", "CTO", "VP of Engineering"]
    }
  }'

​
Path Parameters

ParameterTypeDescription
idstringThe unique search ID

​
Request Body

All fields are optional. Only include fields you want to update.
FieldTypeDescription
namestringNew name for the search
statusstringactive or paused
filters.time_framestringTime range filter
filters.max_resultsintegerMaximum results per run
filters.frequencystringHow often to run
filters.job_titlesarrayJob titles to filter by

​
Status Values

API ValueDescription
activeSearch runs on schedule
pausedSearch is paused

​
Credit Usage

This endpoint is free and does not consume credits.

Headers

​
x-api-key
string
required

Path Parameters

​
id
string
required

Search ID

Example:

"search_abc123xyz"

Body

application/json
​
name
string

Updated name

Required string length: 1 - 255
​
status
enum<string>

Updated status (only active or paused can be set by users)

Available options:
active,
paused
​
filters
object

Updated filters

Response

200 - application/json

Search updated successfully

​
message
string
required
​
success
boolean
required
​
data
object
required