---
title: "Update Run Schedule By Name"
method: PATCH
path: "/agents/{agent_id}/schedules/name/{name}"
tags: ["Schedules"]
---

# Update Run Schedule By Name

`PATCH /agents/{agent_id}/schedules/name/{name}`

Partially update a run schedule's definition by its active name.

## Path parameters

- `agent_id` string, required
- `name` string, required

## Request body

- UpdateAgentRunScheduleRequest — Partial update for a scheduled agent run. Only fields present in the request body are changed. Setting ``cron_expression`` clears ``interval_seconds`` and vice versa; providing both is rejected.
  - `name` string, nullable — Human-readable name, unique among active schedules for the agent.
  - `description` string, nullable — Optional description of what this schedule does.
  - `cron_expression` string, nullable — New cron cadence. Mutually exclusive with interval_seconds.
  - `interval_seconds` integer, nullable — New interval cadence in seconds. Mutually exclusive with cron_expression.
  - `timezone` string, nullable — IANA timezone the cron expression is evaluated in.
  - `start_at` string, date-time, nullable — When the schedule should start being active.
  - `end_at` string, date-time, nullable — When the schedule should stop being active.
  - `paused` boolean, nullable — Pause/resume the schedule as part of the update.
  - `task_params` object, nullable — Resolved config forwarded as task `params` at fire time.
  - `task_metadata` object, nullable — Metadata copied onto each created task at fire time.
  - `initial_input` ScheduleInitialInput — The first input delivered to each freshly created scheduled task.
    - `type` 'text' — Input content type.
    - `author` 'user' | 'agent'
    - `content` string, required — The initial prompt delivered to the task.

## Response `200`

Successful Response

- AgentRunScheduleResponse — Response model describing a scheduled agent run.
  - `id` string, required — The unique identifier of the run schedule.
  - `agent_id` string, required — The agent this schedule belongs to.
  - `name` string, required — Human-readable schedule name.
  - `description` string, nullable — Optional description.
  - `cron_expression` string, nullable — Cron cadence, if cron-based.
  - `interval_seconds` integer, nullable — Interval cadence in seconds, if interval-based.
  - `timezone` string — Timezone the cron expression is evaluated in.
  - `start_at` string, date-time, nullable — Schedule activation time.
  - `end_at` string, date-time, nullable — Schedule deactivation time.
  - `paused` boolean — Whether the schedule is paused.
  - `task_params` object, nullable — Task params at fire time.
  - `task_metadata` object, nullable — Task metadata at fire time.
  - `initial_input` ScheduleInitialInput, required — The first input delivered to each freshly created scheduled task.
    - `type` 'text' — Input content type.
    - `author` 'user' | 'agent'
    - `content` string, required — The initial prompt delivered to the task.
  - `initial_input_method` string, required — Delivery method, inferred from the agent's ACP type.
  - `creator_principal` ScheduleCreatorPrincipal — Credential-free creator identity stored with the schedule. Never carries cookies, JWTs, API keys, OAuth tokens, or request headers — it is creator *context* used only for AuthZ and ownership at fire time.
    - `principal_type` string, nullable — e.g. 'user' or 'service_account'.
    - `user_id` string, nullable — Creator user id, if a user principal.
    - `service_account_id` string, nullable — Creator service-account id, if a service principal.
    - `account_id` string, nullable — Account/workspace id of the creator.
  - `created_at` string, date-time, nullable — When the schedule was created.
  - `updated_at` string, date-time, nullable — When the schedule was updated.
  - `state` 'ACTIVE' | 'PAUSED' — Live state of a run schedule, derived from Temporal.
  - `next_action_times` string[] — Upcoming scheduled fire times.
  - `live_data_available` boolean, nullable — Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.
  - `skipped_action_times` string[] — Skipped one-off scheduled fire times.
  - `last_action_time` string, date-time, nullable — When the schedule last fired.
  - `num_actions_taken` integer — Number of times the schedule has fired.

## Other responses

- `422` — Validation Error

## Changes

> 55 revisions in range; 4 could not be searched.

- **2026-07-10** `fbecbdbd7dc5` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/scaleapi/apis/agentex-api/changes/agents/:agent_id/schedules/name/:name/patch.md)

---

[API](https://skmtc.dev/scaleapi/apis/agentex-api.md) · [All operations](https://skmtc.dev/scaleapi/apis/agentex-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scaleapi/agentex-api/revisions/1e0aaafd5780/schema)