Update workspace automation

PATCH/api/v1/automations/{id}

Updates metadata, resources, triggers, or script for a workspace automation.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?nonEmptyString

a non empty string

Length1 <= length

description?string|null

enabled?boolean

scriptSource?nonEmptyString

a non empty string

Length1 <= length

resources?array<>

triggers?array<>

an array of at least 1 item(s)

Items1 <= items

Response Body

`application/json`

curl -X PATCH "https://loading/api/v1/automations/{id}" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "0f4d6939-7aaf-4d35-a96d-9060ab770001",
  "name": "Lead triage",
  "handle": "lead-triage",
  "url": "/w/acme-growth-team/automations/lead-triage-0f4d6939-7aaf-4d35-a96d-9060ab770001/config",
  "description": "Normalizes inbound leads and routes them to an agent.",
  "enabled": true,
  "scriptSource": "function main(input, api) {\n  api.log('automation started', { input });\n  return { ok: true, input };\n}\n\nmain;",
  "resources": [
    {
      "id": "6d33d7a2-10b1-40e0-b56e-2b87bbdb90ef",
      "label": "Lead triage agent",
      "resourceType": "agent",
      "resourceRef": "support-assistant",
      "config": {},
      "position": 0,
      "createdAt": "2026-03-19T12:00:00.000Z",
      "updatedAt": "2026-03-19T12:00:00.000Z"
    }
  ],
  "triggers": [
    {
      "id": "45bc02e6-e5fb-4c00-89f8-44bf887f40cc",
      "type": "manual",
      "name": "Manual",
      "enabled": true,
      "position": 0,
      "config": {},
      "metadata": {},
      "webhookUrl": null,
      "createdAt": "2026-03-19T12:00:00.000Z",
      "updatedAt": "2026-03-19T12:00:00.000Z"
    },
    {
      "id": "82b6c560-4931-4f92-84f1-fbfb319aeab1",
      "type": "webhook",
      "name": "Inbound lead webhook",
      "enabled": true,
      "position": 1,
      "config": {},
      "metadata": {},
      "webhookUrl": "https://andibase.com/api/v1/automations/webhooks/lead-triage-hook/auto_hook_secret_123",
      "createdAt": "2026-03-19T12:00:00.000Z",
      "updatedAt": "2026-03-19T12:00:00.000Z"
    }
  ],
  "lastRunAt": "2026-03-19T12:10:00.000Z",
  "createdAt": "2026-03-19T12:00:00.000Z",
  "updatedAt": "2026-03-19T12:10:00.000Z"
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "insufficient_permissions",
  "message": "This API key does not have the required permission.",
  "details": {
    "requiredPermission": "resource.action"
  }
}

{
  "code": "not_found",
  "message": "The requested resource was not found."
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Update workspace automation

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`