Update workflow
Updates an existing workflow. The workflow must already exist and belong to the workspace associated with your API key.
This endpoint updates the workflow metadata and creates a new version with the provided nodes, edges, and configuration. If the workflow ID does not match an existing workflow in your workspace, the request will return a 404 error.
Versioning: Every call to this endpoint creates a new workflow version. Versions are immutable and auto-increment. Use GET /workflows/{workflow_id}/versions to list version history, and GET /workflows/{workflow_id}/versions/{version_number} to fetch the full JSON of any prior version (e.g., to inspect, diff, or roll back by re-submitting it via this endpoint).
Typical usage:
GET /workflows/{workflow_id}to fetch the current workflow definition- Modify the
nodes,edges, or other fields as needed PUT /workflows/{workflow_id}with the full updated payload to save a new version
Important: This endpoint requires the full workflow definition. Partial updates are not supported — you must include all required fields (nodes, edges, schemas) even if they haven’t changed.
Authorizations
API key-based authentication. Provide your CloudCruise API key in the cc-key header.
Path Parameters
The ID of the workflow to update
Body
Payload for updating an existing workflow via PUT. The workflow ID is provided in the URL path.
The recommended approach is to first fetch the current workflow via GET /workflows/{workflow_id},
modify the desired fields, and then submit the full payload here.
Display name of the workflow
Array of workflow step nodes. Each node represents an action in the workflow (e.g., click,
type text, navigate, extract data). Pass an empty array [] to clear all nodes.
Map of edges connecting workflow nodes. Keys are source node IDs, values define the outgoing
connections. Pass an empty object {} to clear all edges.
JSON Schema defining the workflow's input variables
{
"type": "object",
"properties": {
"SEARCH_TERM": { "type": ["string", "null"] }
},
"required": ["SEARCH_TERM"]
}JSON Schema defining the workflow's output variables
{ "type": "object", "properties": {} }Maximum number of retry attempts for failed workflow steps
0
Optional description of the workflow
Optional note describing what changed in this version
"Updated login selectors"
Whether to use native browser actions instead of simulated events
Whether to record a video of the workflow execution
URL patterns to extract from network traffic during execution
References to encrypted vault keys used by this workflow
XPath selectors for popups that should be automatically dismissed
Schema defining vault credentials required by this workflow
{
"USER": {
"type": "credential",
"domain": "https://example.com",
"example": "11223344-5566-7788-9900-112233445566"
}
}Proxy configuration setting
Proxy value (e.g., proxy URL or region)
Whether popup handling is enabled
Whether action timing recovery is enabled
Whether XPath recovery is enabled
Whether node descriptions are auto-enriched for reliability improvements
Whether error code generation is enabled
Whether service unavailable recovery is enabled
Whether incorrect form input recovery is enabled
Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.
Whether automatic TFA setup recovery is enabled. When a site requires two-factor authentication setup during login, the Maintenance Agent can autonomously complete the enrollment and update the vault credential.
Whether the network listener is enabled
Whether UDP proxying is skipped during workflow execution
Specific origin catalog workflow version ID used as the base
Base version number used when deriving from a catalog workflow
Response
Workflow updated successfully. Returns the full workflow with the new version number.
Full workflow definition including nodes and edges
Unique identifier for the workflow
Name of the workflow
Timestamp when the workflow was created
Timestamp when the workflow was last updated
ID of the workspace this workflow belongs to
ID of the user who created the workflow
Array of workflow step nodes
Map of edges connecting workflow nodes
Description of the workflow
Current version number of the workflow
ID of the current workflow version
JSON schema defining the workflow's input variables
Schema defining vault credentials and their configuration
Whether popup handling is enabled for this workflow
Whether XPath recovery is enabled for this workflow
Whether node descriptions are auto-enriched for reliability improvements
Whether error code generation is enabled for this workflow
Whether service unavailable recovery is enabled for this workflow
Whether incorrect form input recovery is enabled
Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.
Whether automatic TFA setup recovery is enabled. When a site requires two-factor authentication setup during login, the Maintenance Agent can autonomously complete the enrollment and update the vault credential.
Whether action timing recovery is enabled
ID of the catalog workflow this was forked from (if applicable)
Version number of the catalog workflow this was forked from
Specific origin catalog workflow version ID used as the base
Base version number used when deriving from a catalog workflow
Whether to track updates from the origin catalog workflow
Whether network listener capture is enabled for this workflow version
Whether UDP proxying is skipped for this workflow version