curl --request PATCH \
--url https://api-prod.heliyos.ai/v1/platform/global-scouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cadence": "daily",
"effort": "high"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({cadence: 'daily', effort: 'high'})
};
fetch('https://api-prod.heliyos.ai/v1/platform/global-scouts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/global-scouts/{id}"
payload = {
"cadence": "daily",
"effort": "high"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"meta": {
"message": "Global scout updated successfully"
},
"data": {
"_id": "6731c0a2b4e5f60718293a4b",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Hiring for data roles",
"type": "custom",
"applyTo": "watchlist",
"category": "Hiring",
"queryTemplate": "New job postings at the company for data engineering or analytics roles.",
"cadence": "daily",
"effort": "high",
"isActive": true,
"previewStatus": "completed"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Update a custom Scout
Changes a custom Scout’s fields. Send at least one field; what you leave out is kept. The changes are copied to every company Scout it runs on.
- The scope (
applyTo) cannot change. Sending the current value is accepted; any other value is a 400. selectedCompanyIdsreplaces the selected companies of aselected_watchlistScout. If the Scout is active, it starts on the added companies, and the company Scouts of removed companies are deleted (their signals are kept).- Built-in Scouts cannot be edited (403). Pause or resume them with
Set a workspace Scout’s state (
POST /v1/platform/global-scouts/{id}/state), which is also how you activate or pause a custom Scout.
curl --request PATCH \
--url https://api-prod.heliyos.ai/v1/platform/global-scouts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cadence": "daily",
"effort": "high"
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({cadence: 'daily', effort: 'high'})
};
fetch('https://api-prod.heliyos.ai/v1/platform/global-scouts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/global-scouts/{id}"
payload = {
"cadence": "daily",
"effort": "high"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"meta": {
"message": "Global scout updated successfully"
},
"data": {
"_id": "6731c0a2b4e5f60718293a4b",
"organizationId": "66a0f1e2d3c4b5a697887766",
"name": "Hiring for data roles",
"type": "custom",
"applyTo": "watchlist",
"category": "Hiring",
"queryTemplate": "New job postings at the company for data engineering or analytics roles.",
"cadence": "daily",
"effort": "high",
"isActive": true,
"previewStatus": "completed"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}heliyos_scouts_update.Authorizations
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
The custom Scout's id.
^[0-9a-fA-F]{24}$Body
A new name, 1 to 200 characters after trimming.
1 - 200A new category, 1 to 200 characters after trimming.
1 - 200A new query, 1 to 5,000 characters after trimming.
1 - 5000daily, weekly or monthly.
daily, weekly, monthly The scope cannot change. Only the Scout's current value is accepted.
watchlist, selected_watchlist, entire_web low, medium or high. Changes the credits each run costs.
low, medium, high selected_watchlist Scouts only: the complete new set of watched company record ids, up to 1,000.
1000A 24-character hexadecimal id.
^[0-9a-fA-F]{24}$A new output schema, normalized as on create.
Was this page helpful?

