Skip to main content
PUT
/
workflow-components
/
{component_id}
Update workflow component
curl --request PUT \
  --url https://api.cloudcruise.com/workflow-components/{component_id} \
  --header 'Content-Type: application/json' \
  --header 'cc-key: <api-key>' \
  --data '
{
  "componentData": {
    "nodes": [
      {
        "workflowNode": {
          "id": "<string>",
          "name": "<string>",
          "parameters": {},
          "description": "<string>"
        },
        "position": {
          "x": 123,
          "y": 123
        }
      }
    ],
    "workflowEdges": {},
    "reactFlowEdges": [
      {
        "sourceId": "<string>",
        "targetId": "<string>",
        "sourceHandle": "<string>",
        "targetHandle": "<string>"
      }
    ],
    "vault_schema": {}
  },
  "versionNote": "Fixed login XPath",
  "propagate": true,
  "sourceWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "version_number": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.cloudcruise.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
cc-key
string
header
required

API key-based authentication. Provide your CloudCruise API key in the cc-key header.

Headers

​
cc-key
string

CloudCruise API key for authentication

Path Parameters

​
component_id
string<uuid>
required

The ID of the workflow component to update

Body

application/json

Payload for updating a workflow component's data. Creates a new version and (by default) propagates changes to every workflow in the workspace that contains instances of this component.

​
componentData
object
required

Structural payload for a workflow component — the nodes, edges, and vault schema that compose it. Mirrors the shape used by the workflow visualizer.

​
versionNote
string | null

Optional note describing what changed in this version

Maximum string length: 500
Example:

"Fixed login XPath"

​
propagate
boolean
default:true

If true (default), updates every workflow in the workspace that embeds this component to reflect the new structure. Set to false to save the new version without touching any workflows.

​
sourceWorkflowId
string<uuid> | null

If the update originates from a workflow editor, pass that workflow's id here to skip it during propagation. Workflow-scoped, not instance-scoped — the entire workflow is skipped, including any other instances of this component in it. Use only when the source workflow contains exactly one instance of the component, or when every instance is already in sync with the new componentData. Otherwise omit and let propagation update everything.

Response

Component updated. Returns the new version number.

​
version_number
integer
required

The version number of the newly-created component version

Required range: x >= 1