Skip to main content
POST
Add Scouts to a company
In the Heliyos MCP server: heliyos_companies_scouts_add.

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 company record's id.

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

Body

application/json
defaultScoutIds
string[]
required

1 to 50 workspace Scout ids. Each must be an active Scout with scope watchlist, built in or custom.

Required array length: 1 - 50 elements

A 24-character hexadecimal id.

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

Optional company field values used to build each Scout's query (company_name or name, and website or company_website). When omitted or empty, the record's own values are used. Most callers omit it.

Response

Setup started in the background.

meta
object
required
data
object
required