v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Automations

Update or publish an automation

One endpoint, two mutually-exclusive modes:

  • Update — supply one or more of name, description, nodes, connections, triggerEventId. Graph updates persist a new automationVersionId on the same automationId. Add dryRun: true to validate a graph update without persisting.
  • Lifecycle — supply published: true to promote the stored latest version live (validates the graph first → 409 PUBLISH_VALIDATION_FAILED on blockers; optionally pin automationVersionId to publish a specific version), or published: false to unpublish.

Graph updates use the same strict typed filter/split condition contract as create: explicit type, canonical snake_case operator, no value for unary operators, and type-correct values everywhere else.

The two modes cannot be combined: publishing promotes the stored graph, so update first, then PATCH { "published": true }. Returns the bare automation row.

patch/v1/automations/{automationId}

Path parameters

automationIdstring required

Automation id returned by POST /v1/automations and listed by GET /v1/automations.

Example:auto_abc

Automation id returned by POST /v1/automations and listed by GET /v1/automations.

Request body

namestring
descriptionstring
triggerEventIdstring
dryRunboolean
publishedboolean
automationVersionIdstring
stop_in_flightboolean
pausedboolean

Response

Updated / published / unpublished. The bare automation row (or the dry-run result when dryRun: true).

automationIdstring required
automationVersionIdstring required
triggerEventIdstring
namestring required
descriptionstring
publishedboolean required
pausedboolean
pausedAtnumber
emailIdsstring[] required
createdBystring
createdAtstring date-time
updatedAtstring date-time
publishedAtstring date-time