---
title: "Update Schedule"
method: PATCH
path: "/api/v1/schedules/{schedule_id}"
tags: ["schedules"]
---

# Update Schedule

`PATCH /api/v1/schedules/{schedule_id}`

## Request

- Base URL: `https://api.badgeia.com`
- URL: `https://api.badgeia.com/api/v1/schedules/{schedule_id}`
- Auth: none declared

## Path parameters

- `schedule_id` string, uuid, required

## Request body

- ScheduleUpdate: PATCH: only the fields present are changed.
  - `is_active` boolean, nullable
  - `cadence` 'daily' | 'weekly' | 'on_blueprint_change', nullable
  - `hour_utc` integer, nullable
  - `weekday` integer, nullable
  - `window_minutes` integer, nullable
  - `run_count_k` integer, nullable
  - `budget_cap_usd_per_run` union
    - number
    - string
  - `budget_cap_usd_per_month` union
    - number
    - string
  - `run_request` ScheduleRunRequest: What each occurrence screens. ``agent_id`` is never accepted here.
    - `suite_id` string, uuid, nullable
    - `task_ids` string[], nullable

## Response `200`

Successful Response

- ScheduleRead
  - `id` string, uuid, required
  - `agent_id` string, uuid, required
  - `team_id` string, uuid, nullable, required
  - `run_request` object, required
  - `cadence` 'daily' | 'weekly' | 'on_blueprint_change', required
  - `hour_utc` integer, required
  - `weekday` integer, nullable, required
  - `window_minutes` integer, required
  - `run_count_k` integer, required
  - `budget_cap_usd_per_run` string, nullable, required
  - `budget_cap_usd_per_month` string, nullable, required
  - `spent_usd_month` string, required
  - `consecutive_failures` integer, required
  - `paused_reason` 'budget' | 'endpoint_failures' | 'owner' | 'access_lost' | 'plan' | 'config', nullable, required
  - `is_active` boolean, required
  - `next_run_at` string, date-time, nullable, required
  - `last_run_at` string, date-time, nullable, required
  - `last_screening_session_id` string, uuid, nullable, required
  - `created_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/badgeia/apis/badge.md) · [All operations](https://skmtc.dev/badgeia/apis/badge/llms.txt) · [OpenAPI document](https://skmtc.dev/badgeia/apis/badge/revisions/7e7f7fee8b77?raw)