Update an automation

Changes the name, description, or what it does (steps or graph, which replace all steps). Send the version you read (or If-Match) to avoid overwriting another edit. An active automation must stay ready to run.

Authorization

api-key

AuthorizationBearer <token>

Workspace API key (nim_live_...)

In: header

Path Parameters

id*string

Formatuuid

Header Parameters

if-match*string

If-Match?string

The automation version you last read, e.g. "3".

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

description?|

null or "" clears it.

steps?array<>

Replaces what the automation does. The automation as a list of steps: one trigger first, then the actions, at most 30. Without edges the steps run one after another in this order. To branch with an If step (logic.if), also pass edges, giving each edge out of the If step a sourceHandle of "true" or "false". Send either steps or graph, not both.

edges?array<>

Only with steps (see POST /v1/automations).

graph?

Replaces what the automation does. The full canvas graph ({nodes, edges}) instead of steps, for layouts a list cannot express. Same rules: at most 30 nodes, exactly one trigger to switch it on.

version?number

The version you last read. When it no longer matches, nothing changes and you get 409 VERSION_CONFLICT (read again, then retry). The If-Match header does the same.

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/automations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "if-match: string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "9d2f4b1a-6c3e-4f8a-b5d7-1e0a2c4b6d8f",  "name": "Monday planning reminder",  "description": "string",  "status": "DRAFT",  "pausedReason": "CHANNEL_REMOVED",  "managedBy": null,  "trigger": {    "type": "trigger.schedule",    "summary": "On a schedule (0 9 * * 1 UTC)"  },  "steps": [    {      "id": "notify",      "type": "action.notify",      "name": "Send notification",      "summary": "message: Time to plan the week"    }  ],  "graph": {    "nodes": [      {        "id": "notify",        "type": "action.notify",        "name": "Remind the team",        "position": {          "x": 420,          "y": 200        },        "params": {}      }    ],    "edges": [      {        "id": "e1",        "source": "trigger",        "target": "notify",        "sourceHandle": "main"      }    ]  },  "tags": [    "planning"  ],  "version": 1,  "activateInApp": false,  "lastRunAt": "string",  "nextRunAt": "string",  "createdAt": "2026-10-29T09:00:00.000Z",  "updatedAt": "2026-10-29T09:00:00.000Z",  "appUrl": "https://app.nimply.io/workspace/8b2e5821-…/automations/9d2f4b1a-…"}

Empty