Update an Automation

Update mutable configuration under optimistic versioning: expected_version must match the live version or the request conflicts. AdmissionFilter Check and Outcome evaluator setup use the same create-time vocabulary and retain their distinct defaults and authority; edits affect only later accepted firings, while every existing firing retains its frozen filter, rubric, and resource declarations. Trigger kind, target kind, creator, and SurfaceScope never change, and cursor, delivery, and dedupe state are trusted firing state rather than caller-set configuration. Supplying a new ingest_secret rotates a webhook Automation’s inbound signing key. metadata is replaced whole rather than merged per key, and an empty object clears it; omitting it leaves the bag untouched.

Checkfu support posture: alpha; hosted. Required evidence journey: automation-firing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.

PATCH /v1/automations/{id}

Update an Automation

cURL

curl --request PATCH \
  --url https://api.checkfu.com/v1/automations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'checkfu-version: <checkfu-version>' \
  --data '
{
  "expected_version": 1,
  "name": "<string>",
  "description": "<string>",
  "external_id": "<unknown>",
  "connected_runtime": "<string>",
  "metadata": {},
  "ingest_secret": "<unknown>"
}
'

200

{
  "id": "<string>",
  "workspace_id": "<string>",
  "version": 1,
  "name": "<string>",
  "description": "<string>",
  "external_id": "<string>",
  "created_by": "<string>",
  "identity": {
    "acted_as": "<string>"
  },
  "connected_runtime": "<string>",
  "status": "active",
  "paused_reason": {
    "kind": "manual",
    "error_type": "<unknown>"
  },
  "last_run_at": "<string>",
  "last_session_id": "<string>",
  "last_run_id": "<string>",
  "next_run_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "target": {
    "kind": "agent_definition",
    "agent_deployment_id": "<string>",
    "agent_deployment_revision_selection": {
      "type": "current"
    },
    "budget": {
      "limit": 1,
      "metric": "model_tokens"
    }
  },
  "surface_scope_id": "<string>",
  "trigger": {
    "kind": "schedule",
    "cron": "<string>",
    "timezone": "<string>",
    "dedupe_key": "<unknown>",
    "source": "<unknown>",
    "filter": "<unknown>"
  },
  "input": {
    "kind": "snapshot",
    "prompt": "<string>",
    "outcome": {
      "rubric": "<string>",
      "max_iterations": 10,
      "deliverables": [
        "<string>"
      ],
      "report": {
        "extraction": "json",
        "outputs": [
          {
            "key": "<string>",
            "title": "<string>",
            "type": "string",
            "description": "<string>",
            "acceptance": {
              "kind": "one_of",
              "values": [
                "<string>"
              ]
            }
          }
        ]
      }
    },
    "flow_review": {
      "model_routing_profile_key": "<string>",
      "criteria": [
        {
          "key": "<string>",
          "description": "<string>",
          "severity": "low"
        }
      ],
      "tier": "default"
    },
    "mounts": [
      {
        "kind": "project",
        "project_id": "<string>",
        "mount_path": "<string>",
        "revision_policy": {
          "kind": "latest"
        },
        "access": "read_only",
        "writeback": null
      }
    ],
    "prompt_template": "<unknown>"
  },
  "environment_id": "<string>",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

checkfu-version · enum<string> · required

Available options: 2026-08-29

Path Parameters

id · string · required

Pattern: ^auto_[0-9a-f]{32}$

Body

application/json

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

expected_version · integer · required

Required range: x > 0

name · string

Required string length: 1 - 255

description · string | null

Required string length: 1 - 4096

identity · object

Show child attributes

external_id · any

connected_runtime · string | null

Pattern: ^crt_[0-9a-f]{32}$

metadata · object

at most 16 correlation pairs with keys of 1 to 64 characters

Show child attributes

target · object

Show child attributes

trigger · object

Show child attributes

input · object

Show child attributes

ingest_secret · any

Response

200

application/json

Automation

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

id · string · required

Pattern: ^auto_[0-9a-f]{32}$

workspace_id · string · required

Pattern: ^wrkspc_[0-9a-f]{32}$

version · integer · required

Required range: x > 0

name · string · required

Required string length: 1 - 255

description · string | null · required

Required string length: 1 - 4096

external_id · string | null · required

Pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$

created_by · string · required

Pattern: ^prin_[0-9a-f]{32}$

identity · object · required

Show child attributes

connected_runtime · string | null · required

Pattern: ^crt_[0-9a-f]{32}$

status · enum<string> · required

Available options: active, paused

paused_reason · object · required

Option 1

Option 2

Show child attributes

last_run_at · string | null · required

last_session_id · string | null · required

Pattern: ^sess_[0-9a-f]{32}$

last_run_id · string | null · required

Pattern: ^run_[0-9a-f]{32}$

next_run_at · string | null · required

created_at · string · required

updated_at · string · required

target · object · required

Show child attributes

surface_scope_id · string | null · required

Pattern: ^surf_[0-9a-f]{32}$

trigger · object · required

Show child attributes

input · object · required

Show child attributes

environment_id · string

Pattern: ^env_[0-9a-f]{32}$

metadata · object

at most 16 correlation pairs with keys of 1 to 64 characters

Show child attributes