schedule.update

Update a recurring schedule's name, cadence, target, inputs, or active state

Update a recurring schedule without deleting/recreating it.

Overview

Property	Value
Workflow type	Atomic
Library	App-composition
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
schedule_uuid	uuid	Yes	—	—
target_workflow_type	string	No	—	Registered workflow type to start each occurrence
interval_minutes	integer	No	—	Minutes between runs (minimum 1)
name	string	No	—	Human-facing label
initial_data	json	No	—	Inputs the run starts with (organization_uuid is injected automatically)
active	boolean	No	—	Whether the schedule should fire

Output Schema

Field	Type	Required	Default	Description
schedule	dict	Yes	—	—
changed_fields	list	Yes	—	—
failure_reason	string	No	—	Engine-stamped human-readable failure reason
failure_type	string	No	—	Engine-stamped failure category
failed_action	string	No	—	Engine-stamped action method that raised
failed_at_state	string	No	—	Engine-stamped state when the workflow failed
failed_step	string	No	—	Engine-stamped DAG step that failed
failed_layer	string	No	—	Engine-stamped DAG layer that failed
error	string	No	—	Engine-stamped exception message
error_type	string	No	—	Engine-stamped exception class name

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	complete	Update schedule
completed	No	Yes	Yes	—	Done
failed	No	Yes	No	—	Failed

State Diagram

Transitions

From	Action	To	Description
pending	complete	completed	—
pending	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "schedule.update",
  "initial_data": {
    "organization_uuid": "value",
    "schedule_uuid": "value"
  }
}