Update a scheduled workflow

put

{protocol}://{base-url}/ai/api/v1/workflow/schedules/{schedule_id}

Update an existing scheduled workflow's configuration

Path Params

schedule_id

string

required

The ID of the Scheduled Workflow to use.

Body Params

Schema for updating a scheduled workflow. All fields are optional.

schedule_name

length between 1 and 255

Human-readable name

description

Optional description

workflow_parameters

object | null

Parameters for workflow execution

workflow_configurations

array | null

Named parameter configurations for multi-config scheduling

auth

object | null

Authentication credentials

auth_config_id

UUID of auth_config for managed OAuth credentials

cron_schedule

length between 9 and 50

Cron expression (e.g., '0 3 * * *' for 3 AM daily)

timezone

IANA timezone

enabled

Whether schedule is active

concurrency_policy

ConcurrencyPolicy | null

Concurrency handling policy

timeout_minutes

1 to 1440

Execution timeout in minutes

notify_on_failure

Whether to send an email notification when this schedule's workflow fails

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200Successful Response

401Authentication required. No valid session cookie or bearer token provided, or authentication failed.

404Resource not found. The detail field specifies which resource.

422Validation Error

500Internal server error during request processing.