API Reference
Update automation
Rename an automation, turn it on or off, or repair it with a corrected definition
On this page
This endpoint has two modes:
- Rename / toggle — pass
nameand/orenabledto rename the automation or turn it on/off. - Repair — pass a corrected
flowdefinition and the automation is rebuilt in place, re-tested with a real run, and re-activated only when the test passes. Use this after diagnosing a failure with Get automation and List automation runs.
To undo a repair that made things worse, roll back to the previous published version with Restore previous version.
A repair definition replaces the whole automation — it is never merged. Read the current definition first and resend the complete chain, including every step that must stay; steps you leave out are deleted. The repair test run executes the automation for real, so confirm_side_effects: true is required again when the corrected definition contains sending steps.
Path Parameters
idstringrequired
The ID of the automation (from List automations)
Request body
namestring
A new name for the automation (max 255 characters). In repair mode, the current name is kept when omitted.
enabledboolean
true to turn the automation on, false to turn it off
flowobject
Repair mode: the corrected full definition, in the same format as Create automation ({"trigger": {...}, "steps": [...]}). Max 1 MB.
sampleobject
Sample payload for the repair test run (for assistant events, the canonical sample is used when omitted). Max 256 KB.
assistant_idinteger
For repairs of assistant-event automations: the assistant to (re)attach to. Usually already carried inside the definition's trigger.
confirm_side_effectsboolean
Required (true) when the corrected definition contains steps that send messages or emails, start calls, or make non-GET HTTP requests
A request with none of name, enabled or flow returns a 422 asking for at least one of them.
Response — rename / toggle
dataobject
The refreshed automation summary
Response — repair
The same envelope as Create automation (automation_id, status, test, response, binding), without webhook_url — a repaired automation keeps its original webhook URL. Returned with HTTP 200; status is active, active_untested or test_failed. A repair whose test fails leaves the automation disabled; a repair rejected before the test run (e.g. no_steps) leaves the existing automation untouched.
A missing automation — or one that does not belong to your account — returns a 404 with {"message": "Automation not found"}.
{
"data": {
"id": "f4EaLhOW2zoEsXXSOJP2r",
"name": "Order lookup v2",
"status": "disabled",
"updated": true
}
}
{
"automation_id": "f4EaLhOW2zoEsXXSOJP2r",
"status": "active",
"test": {
"run_status": "SUCCEEDED",
"steps": []
},
"response": null,
"binding": null
}
{
"message": "Automation not found"
}
Related guides
API Reference
Introduction
Welcome to the VoxLink API
Read guide →API Reference
Authentication
Learn how to authenticate your API requests
Read guide →API Reference
Get current user
Get the authenticated user's profile information
Read guide →API Reference
List assistants
List all assistants for the authenticated user with pagination
Read guide →