Create an automation

Creates a draft automation from steps (a trigger, then actions, run in order) or a full graph. It never starts on its own: test it with POST …/test, then switch it on with POST …/activate once the user agrees. Drafts may be incomplete; switching on checks everything.

Authorization

api-key

AuthorizationBearer <token>

Workspace API key (nim_live_...)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

description?string

steps?array<>

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: how the steps connect (needed for If branches). Without it the steps are chained in order.

graph?

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.

Response Body

`application/json`

curl -X POST "https://example.com/v1/automations" \  -H "Content-Type: application/json" \  -d '{    "name": "Monday planning reminder"  }'

{  "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

Authorization

Request Body

Response Body

201application/json

403

422

`application/json`