PATCH
/automations/{automation_id}Update an automation
Updates an automation's name, status, or workflow graph. Supply at least one of name, status, or both steps and connections; workflow graph updates require both arrays together. Provide between 1 and 150 steps when updating the graph.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
automation_idstringrequired
The UUID of the automation to update.
Partial automation update. Supply a name or status, or provide both steps and connections to update the workflow graph.
namestringoptional
The name of the automation.
statusstringoptional
The status of the automation.
stepsarray<object>optional
The steps that compose the automation workflow. Must be provided together with `connections`.
connectionsarray<object>optional
The connections between steps in the automation graph. Must be provided together with `steps`.
200Returns an object containing the identifier of the updated automation.
objectstringoptional
Type of the response object.
idstringoptional
The ID of the updated automation.
Error handling
Provide at least one of name, status, or both steps and connections; name must contain at least one character, and status must be enabled or disabled. When updating the graph, provide both steps and connections, with 1 to 150 steps. The automation_id path parameter must be a UUID and identify an existing automation.