Counter Workflows2

Edges7

Evaluation Workflows4

Global Variables7

LLM Configs12

Node Libraries6

Nodes7

Secure Notifications6

Simulations13

Super Nodes8

Tools18

Upgrade Checklist4

Workflow Categories1

Workflow Execution2

Workflow Favorites2

Workflow Re-run6

Workflow Runs15

Workflow Schedules6

Workflow Templates6

Workflow Versions8

Workflow Webhooks7

Workflows15

Workflow Schedules

Update Workflow Schedule

Changed on Oct 21, 2026

Modify a pending scheduled run (time, inputs, or version).

patch/workflows/v1/workflow-schedules/{schedule_id}

Request

Base URL
https://api-qa.interactly.ai
URL
https://api-qa.interactly.ai/workflows/v1/workflow-schedules/{schedule_id}
Auth
HTTP bearer

Path parameters

schedule_idstring required

Example:5eb7cf5a86d9755df3a6c593

Request body

scheduled_timestring date-time nullable

New scheduled time in UTC

versioninteger nullable

Example request

{
  "run_input": {
    "workflow_id": "5eb7cf5a86d9755df3a6c593",
    "workflow_run_id": "5eb7cf5a86d9755df3a6c593"
  }
}

Response

Successful Response

team_idstring nullable

ID of the team that owns this edge

created_bystring nullable

ID of the user who created this edge

updated_bystring nullable

ID of the user who last updated this edge

created_atstring date-time

updated_atstring date-time

_idstring

workflow_idstring required

status'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled'

scheduled_timestring date-time required

The target time for the workflow execution (UTC)

versioninteger nullable

Version of the workflow to run

schedule_namestring nullable

AWS EventBridge Schedule name (used for deletion)

scheduler_arnstring nullable

AWS EventBridge Scheduler ARN

actual_run_idstring

scheduled_by_namestring nullable

Display name of the user who created the schedule

error_messagestring nullable

Error message if the schedule failed to execute

Example response

{
  "_id": "5eb7cf5a86d9755df3a6c593",
  "workflow_id": "5eb7cf5a86d9755df3a6c593",
  "actual_run_id": "5eb7cf5a86d9755df3a6c593"
}

Changes

Oct 21, 20264a885f58a270 Revision changes
- breaking
  added to the //// response property oneOf list for the response status
- info
  added conversation_fetch store_analysis discriminator mapping keys to the ///// request property
- info
  added to the ///// request property oneOf list
- info
  added conversation_fetch store_analysis discriminator mapping keys to the //// response property for the response status
Aug 24, 2026777675c8a285 Revision changes
- breaking
  removed from the ///// request property oneOf list
- breaking
  added to the //// response property oneOf list for the response status
- info
  added the new optional request property //
- info
  mapped value for discriminator key athena_appointments_create changed from to for ///// request property
- info
  mapped value for discriminator key athena_patients_create changed from to for ///// request property
- info
  mapped value for discriminator key athena_patients_search changed from to for ///// request property
- info
  mapped value for discriminator key athena_patients_update changed from to for ///// request property
- info
  mapped value for discriminator key base_node changed from to for ///// request property
- info
  mapped value for discriminator key deduplicate changed from to for ///// request property
- info
  mapped value for discriminator key end_conversation changed from to for ///// request property
- info
  mapped value for discriminator key field_extractor changed from to for ///// request property
- info
  mapped value for discriminator key google_docs changed from to for ///// request property
- info
  mapped value for discriminator key http_request changed from to for ///// request property
- info
  mapped value for discriminator key llm changed from to for ///// request property
- info
  mapped value for discriminator key no_op changed from to for ///// request property
- info
  mapped value for discriminator key say_static changed from to for ///// request property
- info
  mapped value for discriminator key send_sms changed from to for ///// request property
- info
  mapped value for discriminator key start_conversation changed from to for ///// request property
- info
  mapped value for discriminator key super_node changed from to for ///// request property
- info
  mapped value for discriminator key tool_node changed from to for ///// request property
- info
  mapped value for discriminator key workflow_run_evaluator changed from to for ///// request property
- info
  mapped value for discriminator key workflow_run_fetch changed from to for ///// request property
- info
  added to the ///// request property oneOf list
- info
  mapped value for discriminator key athena_appointments_create changed from to for //// response property for the response status
- info
  mapped value for discriminator key athena_patients_create changed from to for //// response property for the response status
- info
  mapped value for discriminator key athena_patients_search changed from to for //// response property for the response status
- info
  mapped value for discriminator key athena_patients_update changed from to for //// response property for the response status
- info
  mapped value for discriminator key base_node changed from to for //// response property for the response status
- info
  mapped value for discriminator key deduplicate changed from to for //// response property for the response status
- info
  mapped value for discriminator key end_conversation changed from to for //// response property for the response status
- info
  mapped value for discriminator key field_extractor changed from to for //// response property for the response status
- info
  mapped value for discriminator key google_docs changed from to for //// response property for the response status
- info
  mapped value for discriminator key http_request changed from to for //// response property for the response status
- info
  mapped value for discriminator key llm changed from to for //// response property for the response status
- info
  mapped value for discriminator key no_op changed from to for //// response property for the response status
- info
  mapped value for discriminator key say_static changed from to for //// response property for the response status
- info
  mapped value for discriminator key send_sms changed from to for //// response property for the response status
- info
  mapped value for discriminator key start_conversation changed from to for //// response property for the response status
- info
  mapped value for discriminator key super_node changed from to for //// response property for the response status
- info
  mapped value for discriminator key tool_node changed from to for //// response property for the response status
- info
  mapped value for discriminator key workflow_run_evaluator changed from to for //// response property for the response status
- info
  mapped value for discriminator key workflow_run_fetch changed from to for //// response property for the response status
- info
  removed from the //// response property oneOf list for the response status

Operation history (3 revisions)