Skip to main content
PATCH
Edit a scheduled agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
description
string
prompt
string
cron
string
model
string
enabled
boolean
budgetCredits
integer | null

Hard per-run credit cap (whole credits); pass null to remove the cap.

Required range: 1 <= x <= 2147483647

Response

The updated scheduled agent.

object
string
required
Allowed value: "scheduled_agent"
id
string<uuid>
required
workspaceId
string<uuid> | null
required
deprecated

Deprecated container anchor - the legacy workspace, else the origin chat session whose links seed each run; null for container-less agents.

slug
string
required
name
string
required
description
string | null
required
prompt
string
required
cron
string
required
model
string | null
required
enabled
boolean
required
budgetCredits
integer | null
required

Hard per-run credit budget (whole credits). Each run of this agent is capped at this many credits and stops spending once it hits it. Null means no cap. Size it to comfortably cover the leads a run is expected to fetch (cost-per-lead × expected leads, plus margin).

Required range: x >= 1
planBlocked
boolean
required

True when the org cannot currently run scheduled tasks (gated at dispatch).

nextRunAt
string<date-time> | null
required
lastRunAt
string<date-time> | null
required
url
string<uri>
required
handoff
object

Present when planBlocked; points the caller at the upgrade flow.