Automations
PUT
Update Automation
PUT /v1/automations/{automationId}Update an existing automation's configuration and workflow.
Use Cases:
- Modify automation trigger settings
- Add, remove, or update workflow nodes
- Change workflow connections (edges)
- Update automation name or description
- Iterate on draft automations before publishing
Behavior:
- Only provided fields are updated (partial updates supported)
- Only DRAFT automations can be updated
- Validates that all edges reference existing nodes (if both are provided)
- Schema validation is lenient — strict validation happens at publish time
- Returns the complete updated automation object
Required Scope: write:automations
Updatable Fields:
- name: Automation display name (1-100 characters)
- description: Automation description (max 500 characters)
- trigger: Trigger type and configuration
- nodes: Array of workflow nodes
- edges: Array of connections between nodes
Note: To update a published automation, create a new version and publish it. Published automations cannot be directly modified.
Path parameters
automationIdstringrequiredAutomation ID
Bodyrequired
namestringMin length: 1Max length: 100
descriptionanytriggerobjectnodesobject[]edgesobject[]Response
200Automation updated successfully with refreshed configuration
objectstringrequiredidstringrequirednamestringrequireddescriptionanyrequiredstatus"DRAFT" | "PUBLISHED" | "ARCHIVED"requiredversionnumberrequiredparentIdanyrequiredtriggerobjectrequirednodesany[]requirededgesany[]requiredstatsanyrequiredpublishedAtanyrequiredcreatedAtstringrequiredupdatedAtstringrequired