Skip to main content

update_automation

Update an automation. Send only the fields to change — absent fields are left untouched. Supplying a trigger rewrites it and recomputes the schedule's next fire time; supplying an action rewrites it as a whole. Set enabled: false to pause an automation without deleting it.

Request

PATCH /api/v1/ops/projects/{project}/automations/{automationId}
ParameterInTypeRequiredDescription
projectpathstringyesThe project's public id.
automationIdpathstringyesThe automation's public id.
namebodystringnoA new name.
enabledbodybooleannoEnable (true) or pause (false).
triggerbodyobjectnoReplace the trigger ({ type, cron?, tz? } / { type, kind?, filter? }); recomputes nextDueUtc.
actionbodyobjectnoReplace the action ({ type, … }).
conditionbodyobject | nullnoSet a gate ({ "status": "failed" }) or pass null to clear it.
warning

The trigger and action are replaced wholesale, not merged — include their full shape when you change them. Switching a schedule trigger to an event trigger clears nextDueUtc.

curl -X PATCH -H "Authorization: Bearer $TESTVIBE_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "enabled": false }' \
"$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/automations/$AUTOMATION"

Response

200 OK — the updated automation object.

Errors

HTTPWhen
400 invalid_requestAn empty name, an unknown trigger.type/action.type, or an invalid cron.
404 not_foundNo such project, or no such automation in this workspace.