Skip to main content
PATCH
Error

Authorizations

​
X-API-Key
string
header
required

Headers

​
customer
string
required

Workspace identifier

Path Parameters

​
projectId
string
required
​
automationId
string
required

Body

application/json
​
allowAdminTools
boolean

Let runs keep the admin-only data-model, saved-view and template tools, honored only while the user it runs as is a project admin. Can't be turned on with an API key; turn it on in Flow.

​
confirmBeforeExecute
boolean

Branch-review triggers: whether the agent presents a plan for approval before writing. Defaults to true.

​
enabled
boolean

Whether script automation runs are enabled. Defaults to true; ignored in agent mode.

​
mode
enum<string>

What runs: agent (the default) follows prompt; script runs script and needs the automation scripts beta.

Available options:
agent,
script
​
name
string
Example:

"Nightly orphan check"

​
prompt
string

The instructions an agent automation follows. Required in agent mode.

​
runAsMe
boolean

Confirms that this automation should run as you from now on. Required when you are not its current writer and the edit changes what it runs, or how and when it runs. Renaming it, disabling it or turning off admin tools never changes whom it runs as. Sent with no other change, it only makes you the writer.

​
script
string

The python a script automation runs. Required in script mode.

​
trigger
object | null

When the automation runs. Omit or send null for an automation that is only run by hand.

Response

​
id
string
required
​
name
string
required
​
allowAdminTools
boolean
​
confirmBeforeExecute
boolean
​
enabled
boolean

Whether script automation runs are enabled. Defaults to true; ignored in agent mode.

​
mode
enum<string>
Available options:
agent,
script
​
prompt
string
​
runsAs
object
​
script
string
​
trigger
object | null