--- title: "Update Workflow Schedule" method: PATCH path: "/workflows/v1/workflow-schedules/{schedule_id}" tags: ["Workflow Schedules"] --- # Update Workflow Schedule `PATCH /workflows/v1/workflow-schedules/{schedule_id}` Modify a pending scheduled run (time, inputs, or version). ## Path parameters - `schedule_id` string, required ## Request body - BodyUpdateWorkflowScheduleV1WorkflowSchedulesScheduleIdPatch - `scheduled_time` string, date-time, nullable — New scheduled time in UTC - `run_input` WorkflowRunInputInput — Input to the workflow, used to kick off or resume a workflow run. - `dynamic_variables` object — Dynamic variable values that will replace the '{{...}}' placeholders in the prompts, condition strings, tool signatures, etc. - `runtime_variables` object — Runtime variables that will replace the '[[...]]' placeholders in the prompts, condition strings, tool signatures, etc. - `secret_variables` object — Credential-valued variables — every team global marked is_secret, plus the system interactly_api_token. Carried apart from dynamic_variables so that the value a run passes around is NOT the value it emits: see the class docstring. - `miscellaneous` object — Miscellaneous run-input data - `command` 'start' | 'data' | 'resume' | 'pause' | 'stop' - `workflow_id` string - `version_number` integer, nullable — Version number of the workflow this run is associated with. 0 is the initial version (default). - `run_by` string, nullable — Identifier of the user or system that initiated the workflow run - `workflow_run_id` string - `team_id` string, nullable — Team ID associated with this workflow run, used for vendor credential lookup - `start_node_logical_id` string, nullable — Optional logical ID of the node to start execution from, bypassing the default start node. - `initial_state` object, nullable — Optional serialized WorkflowState to resume execution with context. - `thread_to_node_inputs` object — Mapping of thread IDs to node inputs - `welcome_message` string, nullable — Voice-engine opening line, seeded as the first assistant message on the first run only. - `version` integer, nullable ## Response `200` Successful Response - WorkflowScheduledRunsModel — Stores scheduled workflow runs. - `team_id` string, nullable — ID of the team that owns this edge - `created_by` string, nullable — ID of the user who created this edge - `updated_by` string, nullable — ID of the user who last updated this edge - `created_at` string, date-time - `updated_at` string, date-time - `_id` string - `workflow_id` string, required - `status` 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled' - `scheduled_time` string, date-time, required — The target time for the workflow execution (UTC) - `run_input` WorkflowRunInputOutput — Input to the workflow, used to kick off or resume a workflow run. - `dynamic_variables` object — Dynamic variable values that will replace the '{{...}}' placeholders in the prompts, condition strings, tool signatures, etc. - `runtime_variables` object — Runtime variables that will replace the '[[...]]' placeholders in the prompts, condition strings, tool signatures, etc. - `miscellaneous` object — Miscellaneous run-input data - `command` 'start' | 'data' | 'resume' | 'pause' | 'stop' - `workflow_id` string, nullable — DB Object ID of the workflow to run - `version_number` integer, nullable — Version number of the workflow this run is associated with. 0 is the initial version (default). - `run_by` string, nullable — Identifier of the user or system that initiated the workflow run - `workflow_run_id` string, nullable — ID of the workflow run to resume - `team_id` string, nullable — Team ID associated with this workflow run, used for vendor credential lookup - `start_node_logical_id` string, nullable — Optional logical ID of the node to start execution from, bypassing the default start node. - `initial_state` object, nullable — Optional serialized WorkflowState to resume execution with context. - `thread_to_node_inputs` object — Mapping of thread IDs to node inputs - `welcome_message` string, nullable — Voice-engine opening line, seeded as the first assistant message on the first run only. - `version` integer, nullable — Version of the workflow to run - `schedule_name` string, nullable — AWS EventBridge Schedule name (used for deletion) - `scheduler_arn` string, nullable — AWS EventBridge Scheduler ARN - `actual_run_id` string - `scheduled_by_name` string, nullable — Display name of the user who created the schedule - `error_message` string, nullable — Error message if the schedule failed to execute ## Other responses - `422` — Validation Error ## Changes - **2026-08-24** `777675c8a285` — 2 breaking, 41 info - removed `#/components/schemas/BaseNodeRunInput, #/components/schemas/LLMNodeRunInput, #/components/schemas/SayStaticMessageNodeRunInput, #/components/schemas/SuperNodeRunInput, #/components/schemas/WorkflowRunFetchNodeRunInput, #/components/schemas/WorkflowRunEvalLLMNodeRunInput, #/components/schemas/ToolNodeRunInput, #/components/schemas/StartConversationNodeRunInput, #/components/schemas/EndConversationNodeRunInput, #/components/schemas/SendSMSNodeRunInput, #/components/schemas/GoogleDocsNodeRunInput, #/components/schemas/HttpRequestNodeRunInput, #/components/schemas/AthenaPatientsSearchNodeRunInput, #/components/schemas/AthenaPatientsCreateNodeRunInput, #/components/schemas/AthenaPatientsUpdateNodeRunInput, #/components/schemas/AthenaAppointmentsCreateNodeRunInput, #/components/schemas/DeduplicateNodeRunInput, #/components/schemas/FieldExtractorNodeRunInput, #/components/schemas/NoOpNodeRunInput` from the `run_input/anyOf[subschema #1: WorkflowRunInput]/thread_to_node_inputs/additionalProperties/node_run_inputs/items/` request property `oneOf` list - added `#/components/schemas/BaseNodeRunInput-Output, #/components/schemas/LLMNodeRunInput-Output, #/components/schemas/SayStaticMessageNodeRunInput-Output, #/components/schemas/SuperNodeRunInput-Output, #/components/schemas/WorkflowRunFetchNodeRunInput-Output, #/components/schemas/WorkflowRunEvalLLMNodeRunInput-Output, #/components/schemas/ToolNodeRunInput-Output, #/components/schemas/StartConversationNodeRunInput-Output, #/components/schemas/EndConversationNodeRunInput-Output, #/components/schemas/SendSMSNodeRunInput-Output, #/components/schemas/GoogleDocsNodeRunInput-Output, #/components/schemas/HttpRequestNodeRunInput-Output, #/components/schemas/AthenaPatientsSearchNodeRunInput-Output, #/components/schemas/AthenaPatientsCreateNodeRunInput-Output, #/components/schemas/AthenaPatientsUpdateNodeRunInput-Output, #/components/schemas/AthenaAppointmentsCreateNodeRunInput-Output, #/components/schemas/DeduplicateNodeRunInput-Output, #/components/schemas/FieldExtractorNodeRunInput-Output, #/components/schemas/NoOpNodeRunInput-Output` to the `run_input/thread_to_node_inputs/additionalProperties/node_run_inputs/items/` response property `oneOf` list for the response status `200` - added the new optional request property `run_input/anyOf[subschema #1: WorkflowRunInput]/secret_variables` - mapped value for discriminator key `athena_appointments_create` changed from `#/components/schemas/AthenaAppointmentsCreateNodeRunInput` to `#/components/schemas/AthenaAppointmentsCreateNodeRunInput-Input` for `run_input/anyOf[subschema #1: WorkflowRunInput]/thread_to_node_inputs/additionalProperties/node_run_inputs/items/` request property - …39 more - …earlier changes not shown [Full history](https://skmtc.dev/interactly/apis/interactly-api-3/changes/workflows/v1/workflow-schedules/:schedule_id/patch.md) --- [API](https://skmtc.dev/interactly/apis/interactly-api-3.md) · [All operations](https://skmtc.dev/interactly/apis/interactly-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/interactly/interactly-api-3/revisions/35cbea12a781/schema)