Skip to main content
PATCH
Update an automation

Authorizations

Authorization
string
header
required

Your Reason API key from Settings > API. 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, automations:read, automations:write, agent_auth:read. 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

Body

application/json

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

name
string

Display name, trimmed, at most 200 characters. Blank returns 400 name_required.

instructions
string

Trimmed, at most 100,000 characters. Blank returns 400 instructions_required.

model
string | null
tools
object
enabled
boolean

Set false to pause the automation. A paused automation's triggers never fire.

Response

Updated.

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

id
string
org_id
string
name
string | null
instructions
string | null

The system instructions the automation runs with.

model
string | null
enabled
boolean

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

tools
object
environment
object
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>
updated_at
string<date-time>