Skip to main content
PATCH
/
workflow-components
/
{component_id}
Rename workflow component
curl --request PATCH \
  --url https://api.cloudcruise.com/workflow-components/{component_id} \
  --header 'Content-Type: application/json' \
  --header 'cc-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "component_data": {
    "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": {}
  },
  "version_number": 2,
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version_note": "<string>"
}

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

Body

application/json

Payload for renaming a workflow component. Does not create a new version.

​
name
string
required

New display name for the component

Maximum string length: 100

Response

Component renamed successfully

Full workflow component including its latest version's component_data. Returned by GET /workflow-components/{component_id} and the create endpoint.

​
id
string<uuid>
required

Unique identifier for the component

​
workspace_id
string<uuid>
required

ID of the workspace this component belongs to

​
name
string
required

Display name of the component

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
component_data
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.

​
version_number
integer
required

The latest version number of this component

Required range: x >= 1
​
created_by
string<uuid>

ID of the user who created the component

​
version_note
string | null

Optional note describing the latest version's changes