Skip to main content
POST
/
flows
/
schedules
/
{scheduled_flow_run_uid}
/
{action}
Update the status of a scheduled flow_run
curl --request POST \
  --url https://api.edges.run/v1/flows/schedules/{scheduled_flow_run_uid}/{action} \
  --header 'X-API-Key: <api-key>'
{
  "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "flow_preset_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "flow_preset_name": "<string>",
  "user_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "ACTIVE",
  "postponed_until": "2023-11-07T05:31:56Z",
  "cron": "<string>",
  "timezone": "<string>",
  "next_execution_at": "2023-11-07T05:31:56Z",
  "last_executed_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
Manage the lifecycle of a scheduled flow run by pausing, resuming, or cancelling it.

​
Available Actions

ActionDescription
pauseTemporarily pause the schedule - it will not execute until resumed
resumeResume a paused schedule - it will continue executing as scheduled
cancelPermanently cancel the schedule - it cannot be resumed after cancellation

​
Examples

curl --request POST \
  --url https://api.edges.run/v1/flows/schedules/550e8400-e29b-41d4-a716-446655440000/pause \
  --header 'X-API-Key: <your-api-key>'
Temporarily stops the schedule from executing. Use this when you need to temporarily disable a recurring flow.
curl --request POST \
  --url https://api.edges.run/v1/flows/schedules/550e8400-e29b-41d4-a716-446655440000/resume \
  --header 'X-API-Key: <your-api-key>'
Reactivates a paused schedule. It will continue executing according to its cron schedule.
curl --request POST \
  --url https://api.edges.run/v1/flows/schedules/550e8400-e29b-41d4-a716-446655440000/cancel \
  --header 'X-API-Key: <your-api-key>'
Permanently cancels the schedule. This action cannot be undone.

​
Status Transitions

Valid status transitions depend on the current state:
Current StatusValid Actions
ACTIVEpause, cancel
PAUSEDresume, cancel
CANCELLEDNone (terminal state)
COMPLETEDNone (terminal state)

​
Use Cases

​
Pause

  • Temporarily disable automated flows during maintenance
  • Stop execution while updating webhook endpoints
  • Pause flows when you’re over quota/budget

​
Resume

  • Reactivate flows after maintenance
  • Continue automation after webhook updates
  • Resume flows when quota is replenished

​
Cancel

  • Permanently stop flows that are no longer needed
  • Clean up test schedules
  • Remove outdated automation workflows
Cancelling is permanent - Once a schedule is cancelled, it cannot be resumed. You would need to create a new schedule. Use pause if you might want to reactivate it later.
After managing a schedule, you can verify the change with Get Schedule or view all schedules with List Schedules.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
scheduled_flow_run_uid
string
required

Scheduled flow_run UID

​
action
enum<string>
required

With this action, you can resume, cancel or pause the scheduled flow_run.

Available options:
resume,
cancel,
pause

Response

Returns the updated scheduled flow_run

Returns the updated scheduled flow_run

​
uid
string<uuid>

A unique identifier for the scheduled flow run.

​
flow_preset_uid
string<uuid>

A unique identifier for the flow preset associated with this scheduled execution.

​
flow_preset_name
string

The human-readable name of the flow preset executed by this schedule.

​
user_uid
string<uuid>

A unique identifier for the user associated with this scheduled flow run.

​
workspace_uid
string<uuid>

A unique identifier for the workspace associated with this scheduled flow run.

​
status
enum<string> | null

The current status of the scheduled flow run.

Available options:
ACTIVE,
CANCELLED,
PAUSED,
COMPLETED
​
postponed_until
string<date-time> | null

If the flow run is postponed, this field indicates when it will be retried.

​
cron
string | null

The cron expression (in POSIX format) defining the schedule for the flow run.

​
timezone
string | null

The IANA timezone for the scheduled flow run.

​
next_execution_at
string<date-time> | null

The date and time of the next scheduled execution.

​
last_executed_at
string<date-time> | null

The date and time when the flow run was last executed.

​
created_at
string<date-time> | null

The date and time when the scheduled flow run was created.

​
updated_at
string<date-time> | null

The date and time when the scheduled flow run was last updated.