Workflows
Update workflow
Rename a workflow, switch it on (running) or off (paused) with its schedules and sync triggers, or share it with the workspace.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace. List the ones your key can reach with GET /v1/workspaces.
workflow_id*stringThe workflow.
uuidregion*RegionsRegion of the resource: besg (Europe) or usnv (United States), as GET /v1/regions lists them
"besg""usnv"application/json- body
workflow_name?|nullworkflow_status?|running switches the workflow on, paused off
nullis_shared_with_workspace?|nullvalidate_only?Validate OnlyRun every check of the write and answer 204 without writing: a refused write answers the error the write would
falseOK
application/json- response
workflow_id*Workflow Idworkflow_name*Workflow Nameworkflow_resource_id*Workflow Resource Idworkflow_status*WorkflowStatus"running""paused""deleted"workspace_id*Workspace Idis_shared_with_workspace*Is Shared With Workspacemodule_app_type_display_list?array<string>|nullparent_folders?array<>|nullcreated_by*Created Bycreated_time*Created Timelast_modified_by*Last Modified Bylast_modified_time*Last Modified Timeregion*Regions"besg""usnv"curl -X PATCH 'https://api.stacksync.com/v1/workspaces/0/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08?region=besg' \ -H 'Content-Type: application/json' \ -d '{ "workflow_name": "<workflow_name>"}'{ "workflow_id": "<workflow_id>", "workflow_name": "<workflow_name>", "workflow_resource_id": "<workflow_resource_id>", "workflow_status": "running", "workspace_id": 0, "is_shared_with_workspace": false, "module_app_type_display_list": [ "<module_app_type_display_list>" ], "parent_folders": [ { "parent_folder_id": "3f6c1d2e-8a4b-4c7d-9e21-5b6f7a8c9d01", "type": "primary" } ], "created_by": 0, "created_time": "<created_time>", "last_modified_by": 0, "last_modified_time": "<last_modified_time>", "region": "besg"}POSTCreate workflow draft
Open a new editable draft as a copy of a version (the latest when none is given), as the web app's "New draft" does: each step's triggers are then updated for the new draft.
PATCHUpdate workflow options
Merge options (the builder's canvas settings) into a version; a deployed version gets a new draft. Answers the latest version without its document.