Skip to main content
PATCH
Update a custom Scout
In the Heliyos MCP server: heliyos_scouts_update.

Authorizations

Authorization
string
header
required

A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.

Path Parameters

id
string
required

The custom Scout's id.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
name
string

A new name, 1 to 200 characters after trimming.

Required string length: 1 - 200
category
string

A new category, 1 to 200 characters after trimming.

Required string length: 1 - 200
queryTemplate
string

A new query, 1 to 5,000 characters after trimming.

Required string length: 1 - 5000
cadence
enum<string>

daily, weekly or monthly.

Available options:
daily,
weekly,
monthly
applyTo
enum<string>

The scope cannot change. Only the Scout's current value is accepted.

Available options:
watchlist,
selected_watchlist,
entire_web
effort
enum<string>

low, medium or high. Changes the credits each run costs.

Available options:
low,
medium,
high
selectedCompanyIds
string[]

selected_watchlist Scouts only: the complete new set of watched company record ids, up to 1,000.

Maximum array length: 1000

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
outputSchema
object

A new output schema, normalized as on create.

Response

The updated Scout (without signal totals).

meta
object
required
data
object
required

A workspace Scout: what to look for, how often, and on which companies.