AWawork-io
agentSchedules

Updates an agent schedule.

Changed on

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>

put/agents/{agentId}/schedules/{scheduleId}

Request

Path parameters

agentIdstring uuid required

The agent id.

scheduleIdstring uuid required

The schedule id.

Request body

namestring required

The schedule display name.

promptstring nullable

Optional custom instructions for the initial message. Omitted, null, or blank input clears custom instructions.

cronRulestring required

The cron rule used for recurring execution.

recurrenceIntervalinteger nullable

The number of matching cron occurrences between scheduled runs.

timezonestring nullable

The timezone for the cron rule.

projectIdstring uuid nullable

The optional project context id.

taskIdstring uuid nullable

The optional task context id.

isEnabledboolean nullable

Whether the schedule is enabled.

type'personal-agent' | 'custom-agent'

Target type used when reassigning the schedule. Omission preserves the current target.

agentIdstring uuid nullable

The optional target agent id. When omitted, the agent from the update route is kept.

Response

OK

namestring nullable

The schedule display name.

idstring uuid

The schedule id.

createdOnstring date-time

When the schedule was created.

agentIdstring uuid nullable

The agent id that is executed by this schedule.

typestring nullable

Runtime target type: personal-agent or custom-agent.

ownerUserIdstring uuid

The user id whose context is used to execute the scheduled run.

promptstring nullable

Optional custom instructions. An omitted or null prompt means no custom instructions.

cronRulestring nullable

The normalized cron rule used for recurring execution.

recurrenceIntervalinteger

The number of matching cron occurrences between scheduled runs.

timezonestring nullable

The timezone used to evaluate the cron rule.

projectIdstring uuid nullable

The optional project context id.

taskIdstring uuid nullable

The optional task context id.

isTaskContextDeletedboolean

Whether the required task context was deleted.

isEnabledboolean

Whether this schedule is active.

needsAttentionboolean

Whether the schedule needs user attention.

lastFailureReasonstring nullable

The latest rejection reason.

consecutiveFailureCountinteger

The number of consecutive failed scheduled executions.

lastAttemptOnstring date-time nullable

The latest occurrence time.

lastSuccessfulRunOnstring date-time nullable

The latest accepted occurrence time.

Changes

  • ab257be657b1Revision changes
    • info

      added the optional property to the response with the status

  • eadefd26df12Revision changes
    • breaking

      the response property became nullable for the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status