Skip to main content
POST
/
saved-searches
Create a saved search
curl --request POST \
  --url https://app.colacloud.us/api/v1/saved-searches \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Weekly California cabernet approvals",
  "filters": {
    "query": "cabernet",
    "type_wine": true
  },
  "schedule": {
    "cadence": "weekly",
    "day": 0,
    "active": true
  }
}
'
{ "data": { "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "filters": { "query": "<string>", "brand_name": "<string>", "barcode_value": "<string>", "type_malt_beverage": true, "type_wine": true, "type_distilled_spirit": true, "derived_beer": true, "derived_wine": true, "derived_liquor": true, "derived_category": "<string>", "origin_domestic": true, "origin_imported": true, "country": "<string>", "us_state": "<string>", "permit_number_text": "<string>", "applicant_us_state": "<string>", "abv_min": 123, "abv_max": 123, "container_bottle": true, "container_can": true, "container_keg": true, "container_box": true, "container_cask": true, "container_pouch": true, "container_pod": true, "container_carton": true, "container_bag": true, "container_jug": true }, "schedule": { "active": true, "day": 123 }, "created_at": "2023-11-07T05:31:56Z", "manage_url": "<string>", "dashboard_url": "<string>" } }

Documentation Index

Fetch the complete documentation index at: https://docs.colacloud.us/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header

Body

application/json
​
filters
object
required

Filters using non-date web SearchForm field names. Approval-date filters are intentionally not part of saved-search configuration; active recurring schedules apply the date window for each run. ABV bounds only count as meaningful when they narrow the range (abv_min greater than 0 or abv_max less than 100).

​
name
string

Human-readable saved search name

Example:

"Weekly California cabernet approvals"

​
schedule
object

Response

Saved search created

​
data
object