Sign in

v1

latestOpenAPI 3.1.02026-07-22100167210.7 KB
Automation

Update Automation

Updates an existing automation. Only the fields provided in the request body will be updated.

patch/v1/automations/{id}

Path parameters

idstring uuid required

The unique identifier of the automation

Request body

namestring

New name

descriptionstring

New description

promptstring

New prompt

debounce_secondsinteger nullable

Set or clear the per-automation debounce window in seconds. When greater than 0, bursty trigger events update one pending run for this automation and the latest payload runs after the automation stops receiving events for this many seconds. Null or 0 disables debouncing.

environment_idstring uuid

Move this automation to a different environment.

enabledboolean

Enable or disable the automation

workspace_lifecycle_policy'default' | 'archive_when_done' | 'sleep_when_done' | 'delete_after_inactivity'

New lifecycle policy

workspace_auto_stop_minutesinteger nullable

New inactivity timeout in minutes for default keep-alive and delete_after_inactivity policies (set to null to clear)

workspace_size'small' | 'large'

New compute size for every workspace this automation fires off. small (2 vCPU, 8 GB memory, 20 GB disk) bills at $0.008/min; large (4 vCPU, 16 GB memory, 32 GB disk) bills at $0.016/min.

agent_provider'claude' | 'codex' | 'cursor' | 'opencode' | 'pi' | 'null' nullable

New coding agent override. Null inherits the organization default.

modelstring nullable

New model override. Requires agent_provider when set.

thinking_level'low' | 'medium' | 'high' | 'xhigh' | 'max' | 'ultra' | 'ultracode' | 'null' nullable

New thinking/reasoning level override. ultra is Codex-only; ultracode is Claude Code-only.

plan_modeboolean

Enable or disable plan mode for automation messages.

goal_modeboolean nullable

Enable or disable Codex goal mode for automation messages. Null inherits the resolved agent default; false explicitly disables it.

fast_modeboolean nullable

Enable or disable fast mode for automation messages. Null inherits the resolved agent default; false explicitly disables it.

Example request

{
  "triggers": [
    {
      "config": {
        "schedule": "0 9 * * 1-5",
        "timezone": "America/New_York"
      }
    }
  ]
}

Response

Automation updated successfully

Example response

{
  "automation": {
    "triggers": [
      {
        "config": {
          "schedule": "0 9 * * 1-5",
          "timezone": "America/New_York"
        }
      }
    ]
  }
}