Skip to main content
PATCH
Update Scheduled Task
Update any subset of a scheduled task’s fields. Set enabled: false to pause a task without losing its config; set enabled: true to resume. Changes take effect immediately.

Request Body

string
New cron expression (5-field crontab, UTC).
string
New instruction.
string
New label.
boolean
Pause (false) or resume (true) without losing config.

Example Request

Example Response

Authorizations

x-api-key
string
header
required

API Key for authentication

Path Parameters

agent_id
string
required
task_id
string
required

Body

application/json

Update a recurring scheduled task. Only provided fields change.

cron
string | null

New cron expression.

prompt
string | null

New instruction.

title
string | null

New label.

enabled
boolean | null

Pause (false) or resume (true) without losing config.

Response

Successful Response

A recurring scheduled task — the simplified view of one cron task source node.

id
string
required

Source-node id. Pass it to update/remove/run the task.

cron
string
required

Cron expression (5-field crontab, UTC), e.g. '0 9 * * *'.

prompt
string
required

Instruction the agent runs on each fire.

title
string | null

Human-readable label for the task.

enabled
boolean
default:true

Whether the task is active. Disabled tasks keep their config but do not fire.