Sign in

v1

latestOpenAPI 3.1.02026-07-26194149.1 KB
Scouting

Partially update a Scout

Update specific fields of an existing Scout. Only provided fields will be updated; omitted fields remain unchanged.

patch/v1/scouting/tasks/{scout_id}

Path parameters

scout_idstring uuid required

Request body

querystring nullable

String describing what to monitor in natural language

output_intervalinteger nullable

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

user_timezonestring nullable

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

user_locationstring nullable

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

is_publicboolean nullable

Whether the scout is publicly accessible

skip_emailboolean nullable

If true, email notifications will be skipped

output_schemaobject nullable

JSON Schema for structured output (replaces the scout's existing output schema)

webhook_urlstring nullable

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

webhook_format'scout' | 'slack' | 'zapier' nullable

Webhook payload format to use when updating webhook_url. Defaults to 'scout' when omitted. Slack incoming webhook URLs require 'slack'. Only takes effect when webhook_url is also provided in the same request.

Example request

{
  "output_schema": {
    "items": {
      "properties": {
        "headline": {
          "description": "News headline",
          "type": "string"
        },
        "summary": {
          "description": "Brief summary",
          "type": "string"
        },
        "source_url": {
          "description": "URL for more details",
          "type": "string"
        }
      },
      "type": "object"
    },
    "type": "array"
  },
  "webhook_format": "scout"
}

Response

Successful Response

idstring uuid required
querystring required
query_objectobject nullable
display_namestring required
next_run_timestampstring date-time nullable required
user_timezonestring required
next_output_timestampstring date-time nullable required
created_atstring date-time required
completed_atstring date-time nullable required
paused_atstring date-time nullable required
rejection_reason'insufficient_prepaid_balance' | 'budget_exceeded' | 'subscription_inactive'
is_publicboolean
view_urlstring nullable

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

webhook_urlstring nullable

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

output_schemaobject nullable required

JSON Schema for structured output, if configured