Skip to main content
PATCH
Update an automation

Authorizations

Authorization
string
header
required

Your Reason API key from Settings › API keys. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, knowledge:read, memory:read, memory:write, skills:read, skills:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. network:read and network:write are opt-in, excluded from default keys. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

automationId
string
required

The automation id, returned as id by listAutomations and createAutomation.

Body

application/json

All fields optional. Only the fields you send are changed.

name
string

New label that identifies the automation in lists and audit entries; omit it to keep the current name.

Maximum string length: 200
instructions
string

New task for future runs, written as the prompt the agent receives; runs already started keep the old instructions. Omit it to keep the current instructions.

Maximum string length: 100000
model
string | null

Model override for future runs, from the currently available Reason model catalog. Send null to use the workspace default; omit to keep the current override.

tools
object
enabled
boolean

Set false to pause the automation, so none of its triggers fire, or true to resume it. Omit it to keep the current state.

Response

Updated.

An automation: its instructions, tools, environment binding, and triggers.

id
string

Automation id; pass it as automationId to read, update, delete or add triggers.

org_id
string

Workspace the automation belongs to.

name
string | null

Label that identifies the automation.

instructions
string | null

The system instructions the automation runs with.

model
string | null

Model override for its runs; null uses the workspace default.

enabled
boolean

A paused (false) automation's triggers never fire.

tools
object

Tools the automation's runs may use.

environment
object

Repository each run starts in; repo is null for an automation without one.

triggers
object[]

Every condition that fires this automation. Empty until you add one.

warnings
object[]

Present only when the request was accepted but something is not as sent or not usable yet. Codes: schedule_interval_raised, app_tool_not_connected.

created_at
string<date-time>

When the automation was created.

updated_at
string<date-time>

When the automation's configuration last changed.