Skip to content
em sa em sa

Update a saved search

PUT
/api/search/saved/{search_id}
 
curl --request PUT \
  --url https://example.com/api/search/saved/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "query": "example", "mode": "metadata", "filters": {}, "section_key": "example", "alerts_enabled": true, "alert_channel": "in_app" }'

Update a saved search (partial update).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
search_id
required
Search Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
UpdateSavedSearchRequest

Request body for updating a saved search. All fields optional.

object
name
Any of:
string
>= 1 characters <= 100 characters
query
Any of:
string
<= 500 characters
mode
Any of:
string
Allowed values: metadata content semantic
filters
Any of:
object
key
additional properties
any
section_key
Any of:
string
<= 100 characters
alerts_enabled
Any of:
boolean
alert_channel
Any of:
string
Allowed values: in_app email both

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
SavedSearchResponse

Response model for a saved search.

object
id
required
Id
string
name
required
Name
string
query
required
Query
string
mode
required
Mode
string
filters
required
Filters
object
key
additional properties
any
section_key
Any of:
string
alerts_enabled
required
Alerts Enabled
boolean
alert_channel
required
Alert Channel
string
last_result_count
required
Last Result Count
integer
last_scanned_at
Any of:
string
created_at
required
Created At
string
updated_at
required
Updated At
string
Example generated
{
  "id": "example",
  "name": "example",
  "query": "example",
  "mode": "example",
  "filters": {},
  "section_key": "example",
  "alerts_enabled": true,
  "alert_channel": "example",
  "last_result_count": 1,
  "last_scanned_at": "example",
  "created_at": "example",
  "updated_at": "example"
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}