Update a schedule
Change a schedule’s cadence, message, or overlap policy. State is not one of them.
spec is editable: the schedule rules (timezone, calendars, intervals), firstUserMessage, systemPromptData, overlapPolicy, and the pinned variationId. The update merges, so send only what you are changing. The new cadence takes effect from the next computed fire.
An archived schedule cannot be updated, a PATCH against one is a 400. Update an active or paused schedule instead.
Related
Create a schedule
Pause a schedule
List schedules
nextFireAt.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace ID.
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.
"agent_01HXKD2E5NQM3T9AYWCFMGWT9Y"
Schedule ID. Accepts the canonical as_… form or the external_id:<value> form.
"as_01HXKD2E5NQM3T9AYWCFMZZZBD"
Body
Update agent schedule request.
UpdateResourceMetadata contains the user-provided fields for updating a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id, created_at) are excluded since they are set by the server.
AgentScheduleSpec is the user-provided configuration for a schedule.
Fields to update.
Response
OK
AgentSchedule resource — a recurring trigger attached to an agent that creates objectives on its cadence.
Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
AgentScheduleSpec is the user-provided configuration for a schedule.
The current lifecycle state of the schedule. Output only. Schedules are created STATE_ACTIVE; use the :pause, :resume, and :archive actions to transition between states.
STATE_UNSPECIFIED, STATE_ACTIVE, STATE_PAUSED, STATE_ARCHIVED AgentScheduleInfo provides read-only runtime data about a schedule.