Workflows
Update workflow
Turn a workflow on or off, rename it, or set its settings, its computer and its time zone.
PATCH
Rename a workflow, turn it on or off, or set its settings
Changes what a workflow is set to, never its steps. Send only the fields you change. To change its steps, use Replace a workflow’s steps.
Turning a workflow on sets up its start: a timed start is scheduled, and an app event is watched on the computer’s own sign-in of that app. When it can’t run yet, turning it on answers
Replace It can’t run yet (
When the missing piece is an app to connect on its computer, the body also carries
422 with code: "not_ready" and a to_fix list, and nothing changes. Any other change that leaves it unable to run turns it off, and the answer says turned_off: true.
Path parameters
Headers
Request body
What it asks for once, name to value, like
{ "channel": "sales" }. Only the names you send change. "" or null takes one out.The UUID of the computer its steps run on, one of yours (from List workspaces or Get workspace).
null or "" takes it off. Picking one takes a key with Control write and AI write.An IANA zone its times and date words are read in, like
America/New_York. A timed start needs one.Response
The workflow as kept, in the same shape Get a workflow answers, with the new version inversion and the ETag header. turned_off: true appears when this change turned it off.
Example
$COMPUTER_ID with the computer’s UUID.
It can’t run yet (422)
needs, the apps to connect.
Errors
Authorizations
Headers
Body
application/json
Response
The workflow, as kept.
The workflow, one JSON object per step, the start first (https://www.orgo.ai/workflows.md).