---
title: "Partially update a Scout"
method: PATCH
path: "/v1/scouting/tasks/{scout_id}"
tags: ["Scouting"]
---

# Partially update a Scout

`PATCH /v1/scouting/tasks/{scout_id}`

## Request

- Base URL: `https://api.yutori.com`
- URL: `https://api.yutori.com/v1/scouting/tasks/{scout_id}`
- Auth: API key in header `x-api-key`

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

## Path parameters

- `scout_id` string, uuid, required

## Request body

- PatchScoutRequestAPI: Experimental: Partial update for a Scout via the Developer API. Only provided fields will be updated; omitted fields remain unchanged.
  - `query` string, nullable: String describing what to monitor in natural language
  - `output_interval` integer, nullable: Interval in seconds between outputs (must be >= 1800)
  - `user_timezone` string, nullable: User's timezone (e.g. 'America/Los_Angeles')
  - `user_location` string, nullable: User's coarse location (e.g. 'San Francisco, CA, US')
  - `is_public` boolean, nullable: Whether the scout is publicly accessible
  - `skip_email` boolean, nullable: If true, email notifications will be skipped
  - `output_schema` object, nullable: JSON Schema for structured output (replaces the scout's existing output schema)
  - `webhook_url` string, 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.

## Response `200`

Successful Response

- CreateScoutResponsePublic: Public API response for scout creation. Excludes internal fields like llm_output.
  - `id` string, uuid, required
  - `query` string, required
  - `query_object` object, nullable
  - `display_name` string, required
  - `next_run_timestamp` string, date-time, nullable, required
  - `user_timezone` string, required
  - `next_output_timestamp` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `completed_at` string, date-time, nullable, required
  - `paused_at` string, date-time, nullable, required
  - `rejection_reason` 'insufficient_prepaid_balance' | 'budget_exceeded' | 'subscription_inactive'
  - `is_public` boolean
  - `view_url` string, nullable: URL to view this scout's details in the API platform dashboard.
  - `webhook_url` string, nullable: Optional webhook URL configured for this scout, if provided at creation time.
  - `output_schema` object, nullable, required: JSON Schema for structured output, if configured

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/yutori/apis/yutori-api.md) - [All operations](https://skmtc.dev/yutori/apis/yutori-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yutori/apis/yutori-api/revisions/ef669f82d5bc?raw)