Beta

Update an automation

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
PATCH
/v1/automations/{automation_id}

Changes an automation's name, what it does (instruction or action), trigger, where (the conditions an event must match; null or [] for none), Room or business (null for none), or when it tells you; or pauses it (status paused) or turns it back on (status active).

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Path Parameters

automation_id*string
Match^aut_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

SMB-Workspace-Id*string

Workspace where this operation runs. Required for user tokens and Workspace API keys.

Formatuuid
Idempotency-Key*string
Length8 <= length <= 200

Request Body

application/json
  1. body
name?string
Length1 <= length <= 120
instruction?string

What SMB should do each time it runs, in plain words.

Length1 <= length <= 4000
action?||

What it does: ask SMB's agent (kind agent, with an instruction), run one listed operation as you (kind operation), or send a signed automation.run message to one of your webhooks (kind webhook). Give this or instruction.

trigger?||||||

When it runs: a schedule (every N hours, or a day, weekdays, week or month at a time, in a time zone; every 5, 10, 15 or 30 minutes for an operation or webhook), an event (types from list_event_types; set where, room_id or business_id to narrow it), or manual (only when run by hand).

where?array<>|null
room_id?|null
business_id?|null
notify?Notify

When to tell you: when there's something to report (default), every run, only failures, or never.

Value in"when_reporting""every_run""failures""never"
status?string
Value in"active""paused"

Response Body

Successful authorized response.

application/json
  1. response
data*
request_id*string
curl -X PATCH 'https://example.com/v1/automations/string' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Idempotency-Key: stringst' \  -H 'Content-Type: application/json' \  -d '{}'
{  "data": {    "id": "string",    "name": "string",    "action": {      "property1": null,      "property2": null    },    "trigger": {      "property1": null,      "property2": null    },    "where": [      {        "property1": null,        "property2": null      }    ],    "room_id": "string",    "business_id": "string",    "notify": "string",    "status": "active",    "attention_reason": "failing",    "next_run_at": "string",    "last_run_at": "string",    "latest_run_at": "string",    "last_run_status": "queued",    "runs_as": {      "type": "person",      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",      "name": "string"    },    "created_at": "string",    "updated_at": "string"  },  "request_id": "string"}