Skip to main content
PATCH
Update schedule

Authorizations

Authorization
string
header
required

JWT authentication token

Path Parameters

id
string<uuid>
required

Schedule ID

Body

application/json

On the BYOK model source a schedule cannot name a credential: llm_model carries no credential_ref. A model ID that both a fixed-provider key and a custom endpoint serve runs on the fixed-provider key.

anchor_at
string<date-time> | null
custom_weekdays
integer[] | null
Required range: 0 <= x <= 6
day_of_month
integer

Single monthly UTC calendar day. Shorter months use their last day. Omit for legacy anchor-day behavior.

Required range: 1 <= x <= 31
direct_agent_id
string | null

Route every run to this agent. Use an id from GET /api/v1/agents. A team-shared agent's UUID is accepted; it must be accessible to the schedule owner.

end_at
string<date-time>

End date for end_mode=on_date. Use end_mode=never to remove the end condition.

end_mode
enum<string>

Select the end condition; never clears both limits

Available options:
never,
on_date,
after
file_keys
string[] | null
interval_count
integer
Required range: 1 <= x <= 100
llm_model
string

LLM model identifier. Values may be Neo model labels or provider-native model IDs discovered at runtime from an AI connection. "auto" defers model selection to the agent, which picks per-request based on task complexity, cost, and security context.

Minimum string length: 1
max_occurrences
integer

Run limit for end_mode=after. Use end_mode=never to remove the end condition.

Required range: x >= 1
name
string
Maximum string length: 256
reporting_mode
enum<string>

Output reporting mode - 'full' returns all data (default), 'changes_only' generates a diff report. Omit the field to leave unchanged.

Available options:
full,
changes_only
run_at
string

For one_time schedules - relative ("5m", "1h", "2d") or absolute ("14:30", "3:00PM") time. Required when changing to one_time.

scan_frequency
enum<string>
Available options:
daily,
weekly,
monthly,
custom
schedule_type
enum<string>

Change schedule type. Requires run_at when changing to one_time, or scan_frequency when changing to recurring.

Available options:
recurring,
one_time
secrets
string[] | null

Selected personal secret names or stable saved-secret references (secret:), reauthorized at each scheduled execution.

start_time
string | null

Start time in HH:MM format (24h)

subagent_models
string[]

Optional subagent model list. Omit the field to leave it unchanged; send an empty list to clear it. The schedule stores the list as intent, not as an approved list: every run admits it again against the account's model source at that time. A model that is no longer available pauses the schedule with worker_model_not_admitted.

Maximum array length: 50
Required string length: 1 - 200
subagent_reasoning_effort
enum<string>
default:auto

Optional ceiling for subagent reasoning effort, stored with the schedule and applied on every run. Omit the field to leave it unchanged.

Available options:
auto,
low,
medium,
high,
max
task_message
string
Minimum string length: 1

Response

Schedule updated

schedule
object
required