Change an automation
Changes an automation’s name, description, limits, notifications, project or whether it is enabled. Send only what changes. Returns the automation as GET does.
Requires the automations:write permission.
Authorizations
An API key from Settings → API keys, sent as Authorization: Bearer jb_live_…
Path Parameters
The automation id.
64Body
Send only the fields to change.
A new name.
1 - 80Turn the automation on or off. It cannot be turned on while it is over its monthly limit.
Pause after this many failures in a row. Null turns it off.
1 <= x <= 100Move to a project, or null to take it out of one. Only the owner can.
64A description. Null or empty goes back to the one in the package.
500Monthly spending limit in credits. Null removes the limit.
x <= 10000000Whether it may act without asking. Only the owner can change it.
Limits by service in credits. Null removes one.
Response
The automation after the change.
An automation.
The automation id.
The name.
Whether it starts on its triggers. A paused automation is not enabled.
draft (nothing published), attention (needs the person), paused or active.
draft, attention, paused, active The account that owns it.
A short name used in addresses.
The live version. Null for a draft.
Why it paused: manual, failures or budget.
manual, failures, budget, null When it paused.
It pauses after this many failures in a row.
What it does.
Whether the description was written by a person rather than taken from the package.
The monthly spending limit in US dollars.
The monthly spending limit in credits.
Whether it may take actions without asking.
Spending limits by service in US dollars.
Spending limits by service (ai, agent) in credits.
When it was created.
The project it belongs to.
The account's role on it.
owner, editor, viewer Why it needs the person.
missing_secrets, missing_accounts, account_expired, question, approval, consent, build_failed, paused_after_failures, paused_for_budget, failing Secret names the live version needs and does not have.
Connected-account slots that are not usable.
Whether a run is in progress.
How the automation has been doing.
The live version (see AutomationVersion).
A newer version that is not live yet, such as one awaiting consent or one that failed to build.
Schedules of the live version.
Runs held back while they wait for a connected account.
Webhooks that start it. Secrets are shown only to keys with webhooks:write.
The mailbox that starts it: trigger_id and address. The address is hidden from keys without webhooks:write.
Polling sources and their state.