SCscaleapi
Schedules

Update Run Schedule By Name

Changed on

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

patch/agents/{agent_id}/schedules/name/{name}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

agent_idstring required
namestring required

Request body

namestring nullable

Human-readable name, unique among active schedules for the agent.

descriptionstring nullable

Optional description of what this schedule does.

cron_expressionstring nullable

New cron cadence. Mutually exclusive with interval_seconds.

interval_secondsinteger nullable

New interval cadence in seconds. Mutually exclusive with cron_expression.

timezonestring nullable

IANA timezone the cron expression is evaluated in.

start_atstring date-time nullable

When the schedule should start being active.

end_atstring date-time nullable

When the schedule should stop being active.

pausedboolean nullable

Pause/resume the schedule as part of the update.

task_paramsobject nullable

Resolved config forwarded as task params at fire time.

task_metadataobject nullable

Metadata copied onto each created task at fire time.

Response

Successful Response

idstring required

The unique identifier of the run schedule.

agent_idstring required

The agent this schedule belongs to.

namestring required

Human-readable schedule name.

descriptionstring nullable

Optional description.

cron_expressionstring nullable

Cron cadence, if cron-based.

interval_secondsinteger nullable

Interval cadence in seconds, if interval-based.

timezonestring

Timezone the cron expression is evaluated in.

start_atstring date-time nullable

Schedule activation time.

end_atstring date-time nullable

Schedule deactivation time.

pausedboolean

Whether the schedule is paused.

task_paramsobject nullable

Task params at fire time.

task_metadataobject nullable

Task metadata at fire time.

initial_input_methodstring required

Delivery method, inferred from the agent's ACP type.

created_atstring date-time nullable

When the schedule was created.

updated_atstring date-time nullable

When the schedule was updated.

state'ACTIVE' | 'PAUSED'

Live state of a run schedule, derived from Temporal.

next_action_timesstring[]

Upcoming scheduled fire times.

live_data_availableboolean nullable

Whether requested live Temporal fields were retrieved successfully. Null when live enrichment was not requested.

skipped_action_timesstring[]

Skipped one-off scheduled fire times.

last_action_timestring date-time nullable

When the schedule last fired.

num_actions_takeninteger

Number of times the schedule has fired.

Changes