SnozeDevelopers
API referenceAutomations

Disable an automation

Turns the automation off so its published triggers stop firing, and returns it. Requires the `automations:write` permission plus edit access; an automation that is already disabled is returned unchanged. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

POST
/v1/workspaces/{workspaceId}/automations/{automationId}/disable

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Path Parameters

workspaceId*string
automationId*string

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/workspaces/string/automations/string/disable'
Example Response
{  "data": {    "referenceIssues": [      {        "nodeId": "string",        "message": "string"      }    ],    "id": "string",    "workspaceId": "string",    "key": "string",    "label": "string",    "enabled": true,    "versionId": "string",    "version": 0,    "publishedVersionId": "string",    "draftVersionId": "string",    "hasUnpublishedChanges": true,    "trigger": "manual",    "triggerConfig": {      "kind": "manual"    },    "graph": {      "reusable": {        "inputs": [          {            "key": "string",            "label": "string",            "type": "text",            "required": true          }        ],        "outputs": [          {            "key": "string",            "label": "string",            "type": "text",            "required": true,            "value": {              "type": "literal",              "value": null            }          }        ]      },      "nodes": [        {          "id": "string",          "label": "string",          "retry": {            "maxAttempts": 0,            "initialDelaySeconds": 0,            "backoffMultiplier": 0,            "maxDelaySeconds": 0          },          "position": {            "x": 0,            "y": 0          },          "kind": "action",          "actionId": "string",          "input": {            "property1": {              "type": "literal",              "value": null            },            "property2": {              "type": "literal",              "value": null            }          }        }      ],      "edges": [        {          "id": "string",          "from": "string",          "to": "string",          "outcome": "always"        }      ],      "entryNodeIds": [        "string"      ],      "testPayloads": [        {          "id": "string",          "name": "string",          "payload": {}        }      ],      "failureAutomationId": "string",      "triggerPosition": {        "x": 0,        "y": 0      }    },    "webhookPath": "string",    "webhookSecret": "string",    "webhookActive": true,    "runAs": {      "kind": "workspace",      "connectionId": "string"    },    "aiMonthlyBudgetMicrousd": 0,    "nextRunAt": "string",    "lastTriggeredAt": "string",    "createdAt": "string",    "updatedAt": "string"  }}

Enable an automation

Turns the automation on and returns it; an automation that has never been published is published first, since publishing is what makes it live. Requires the `automations:write` permission plus edit access; an already-enabled automation is returned unchanged, and the publish path still enforces its preconditions, so an empty or invalid graph is rejected with a validation error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.

Run an automation now

Queues a manual run of the automation's published version, seeded with the optional `triggerPayload`, and returns the queued run. Requires the `automations:write` permission plus edit access; an automation that is not both published and enabled is rejected with a run error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.