Skip to main content
PATCH
/
v1
/
scouting
/
tasks
/
{scout_id}
Partially update a Scout
curl --request PATCH \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>",
  "output_interval": 1801,
  "user_timezone": "<string>",
  "user_location": "<string>",
  "is_public": true,
  "skip_email": true,
  "webhook_url": "<string>",
  "webhook_format": "scout"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>",
  "display_name": "<string>",
  "next_run_timestamp": "2023-11-07T05:31:56Z",
  "user_timezone": "<string>",
  "next_output_timestamp": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "paused_at": "2023-11-07T05:31:56Z",
  "query_object": {},
  "is_public": true,
  "view_url": "<string>",
  "webhook_url": "<string>"
}

​
Overview

Partially update a Scout’s configuration. This is useful when you want to:
  • Change a single setting without re-submitting the entire configuration
  • Toggle visibility or notification settings
  • Update the monitoring frequency

​
Supported Fields

FieldTypeDescription
querystringThe monitoring query in natural language
output_intervalintegerSeconds between outputs (minimum: 3600)
user_timezonestringTimezone string (e.g., “America/Los_Angeles”)
user_locationstringLocation string (e.g., “San Francisco, CA, US”)
is_publicbooleanWhether the scout is publicly accessible
skip_emailbooleanWhether to skip email notifications
webhook_urlstringWebhook URL for updates (empty string to remove)

​
Use Cases

​
1. Update Output Frequency

Change how often the scout runs without touching other settings:
Request
curl --request PATCH \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id} \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "output_interval": 7200
  }'
Response
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "query": "Latest news about AI startups",
  "display_name": "AI Startup News",
  "next_run_timestamp": "2024-01-15T10:00:00Z",
  "user_timezone": "America/Los_Angeles",
  "next_output_timestamp": "2024-01-15T12:00:00Z",
  "created_at": "2024-01-01T00:00:00Z",
  "completed_at": null,
  "paused_at": null,
  "is_public": true,
  "webhook_url": null
}

​
2. Toggle Visibility

Make a scout private or public:
Request
curl --request PATCH \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id} \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "is_public": false
  }'

​
3. Disable Email Notifications

Stop receiving emails while keeping the scout running:
Request
curl --request PATCH \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id} \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "skip_email": true
  }'

​
4. Update Multiple Fields

Change several settings at once:
Request
curl --request PATCH \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id} \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "Updated monitoring query",
    "output_interval": 14400,
    "is_public": false,
    "skip_email": true
  }'

​
5. Add or Update Webhook

Set up webhook notifications:
Request
curl --request PATCH \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id} \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "webhook_url": "https://your-server.com/webhook"
  }'

​
6. Remove Webhook

Remove webhook by setting to empty string:
Request
curl --request PATCH \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id} \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "webhook_url": ""
  }'

​
Error Responses

​
400 Bad Request - No Fields Provided

{
  "detail": "At least one field must be provided for update"
}

​
400 Bad Request - Invalid Output Interval

{
  "detail": [
    {
      "type": "greater_than_equal",
      "loc": ["body", "output_interval"],
      "msg": "Input should be greater than or equal to 3600",
      "input": 1800
    }
  ]
}

​
400 Bad Request - Invalid Webhook URL

{
  "detail": "Invalid webhook URL"
}

​
403 Forbidden - Not the Creator

{
  "detail": "Only the creator of a scout can edit it"
}

​
404 Not Found

{
  "detail": "Scout with id {scout_id} not found"
}

​
Notes

  • Only the scout creator can use this endpoint
  • Omitted fields retain their current values
  • Webhook URLs must use HTTPS
  • This endpoint is idempotent - safe to retry

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
scout_id
string<uuid>
required

Body

application/json

Experimental: Partial update for a Scout via the Developer API. Only provided fields will be updated; omitted fields remain unchanged.

​
query
string | null

String describing what to monitor in natural language

​
output_interval
integer | null

Interval in seconds between outputs (must be >= 1800)

Required range: x >= 1800
​
user_timezone
string | null

User's timezone (e.g. 'America/Los_Angeles')

​
user_location
string | null

User's coarse location (e.g. 'San Francisco, CA, US')

​
is_public
boolean | null

Whether the scout is publicly accessible

​
skip_email
boolean | null

If true, email notifications will be skipped

​
webhook_url
string | null

Webhook URL to receive updates (set to empty string to remove)

​
webhook_format
enum<string> | null

Webhook payload format to use when updating webhook_url. Defaults to 'scout' when omitted. Slack incoming webhook URLs require 'slack'.

Available options:
scout,
slack,
zapier
Example:

"scout"

Response

Successful Response

Public API response for scout creation. Excludes internal fields like llm_output.

​
id
string<uuid>
required
​
query
string
required
​
display_name
string
required
​
next_run_timestamp
string<date-time> | null
required
​
user_timezone
string
required
​
next_output_timestamp
string<date-time> | null
required
​
created_at
string<date-time>
required
​
completed_at
string<date-time> | null
required
​
paused_at
string<date-time> | null
required
​
query_object
Query Object · object
​
is_public
boolean
default:true
​
view_url
string | null

URL to view this scout's details in the API platform dashboard.

​
webhook_url
string | null

Optional webhook URL configured for this scout, if provided at creation time.