Saved Searches

Create a saved search

Create a durable saved search using the non-date filter field names from the web app's SearchForm. Include a schedule object to enable a recurring saved-search alert.

OAuth callers must have the saved_searches:write scope. Approval-date filters are not saved-search configuration; scheduled runs use the saved search's previous run and current run as the approval-date window. Broad recurring searches without a meaningful filter are rejected. Each user can have up to 10 active scheduled watchlists.

post/saved-searches

Request

  • Base URL: https://app.colacloud.us/api/v1
  • URL: https://app.colacloud.us/api/v1/saved-searches
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

namestring

Human-readable saved search name

Example request

{
  "name": "Weekly California cabernet approvals"
}

Response

Saved search created

Changes

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