API v1 ReferenceAgent Schedules

Updates an agent schedule.

Updates a schedule configured for an agent after validating its cadence, timezone, and optional context. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agentIdstringRequiredformat: "uuid"
The agent id.
scheduleIdstringRequiredformat: "uuid"
The schedule id.

Request

The updated schedule payload.
namestringRequired1-255 characters
The schedule display name.
cronRulestringRequired1-100 characters
The cron rule used for recurring execution.
promptstring or nullOptional<=25000 characters
Optional custom instructions for the initial message. Omitted, null, or blank input clears custom instructions.
recurrenceIntervalinteger or nullOptional1-99
The number of matching cron occurrences between scheduled runs.
timezonestring or nullOptional<=100 characters
The timezone for the cron rule.
projectIdstring or nullOptionalformat: "uuid"
The optional project context id.
taskIdstring or nullOptionalformat: "uuid"
The optional task context id.
isEnabledboolean or nullOptional
Whether the schedule is enabled.
agentIdstring or nullOptionalformat: "uuid"
The optional target agent id. When omitted, the agent from the update route is kept.

Response

OK
namestring or nullOptional
The schedule display name.
idstringOptionalformat: "uuid"
The schedule id.
createdOnstringOptionalformat: "date-time"
When the schedule was created.
agentIdstringOptionalformat: "uuid"
The agent id that is executed by this schedule.
ownerUserIdstringOptionalformat: "uuid"
The user id whose context is used to execute the scheduled run.
promptstring or nullOptional
Optional custom instructions. An omitted or null prompt means no custom instructions.
cronRulestring or nullOptional
The normalized cron rule used for recurring execution.
recurrenceIntervalintegerOptional
The number of matching cron occurrences between scheduled runs.
timezonestring or nullOptional
The timezone used to evaluate the cron rule.
projectIdstring or nullOptionalformat: "uuid"
The optional project context id.
taskIdstring or nullOptionalformat: "uuid"
The optional task context id.
isEnabledbooleanOptional
Whether this schedule is active.
needsAttentionbooleanOptional
Whether the schedule needs user attention.
lastFailureReasonstring or nullOptional
The latest rejection reason.
consecutiveFailureCountintegerOptional
The number of consecutive failed scheduled executions.
lastAttemptOnstring or nullOptionalformat: "date-time"
The latest occurrence time.
lastSuccessfulRunOnstring or nullOptionalformat: "date-time"
The latest accepted occurrence time.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error