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>"
}
'import requests
url = "https://api.cloudcruise.com/workflow-components/{component_id}"
payload = { "name": "<string>" }
headers = {
"cc-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'cc-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://api.cloudcruise.com/workflow-components/{component_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloudcruise.com/workflow-components/{component_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"cc-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudcruise.com/workflow-components/{component_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cc-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.cloudcruise.com/workflow-components/{component_id}")
.header("cc-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudcruise.com/workflow-components/{component_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cc-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"action": "START",
"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>"
}Rename workflow component
Updates only the component’s display name. Does not create a new version and does not propagate to embedded instances.
For changes to component_data (the actual node/edge structure), use PUT /workflow-components/{component_id} instead.
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>"
}
'import requests
url = "https://api.cloudcruise.com/workflow-components/{component_id}"
payload = { "name": "<string>" }
headers = {
"cc-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'cc-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>'})
};
fetch('https://api.cloudcruise.com/workflow-components/{component_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cloudcruise.com/workflow-components/{component_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"cc-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cloudcruise.com/workflow-components/{component_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("cc-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.cloudcruise.com/workflow-components/{component_id}")
.header("cc-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloudcruise.com/workflow-components/{component_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["cc-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"action": "START",
"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>"
}Authorizations
API key-based authentication. Provide your CloudCruise API key in the cc-key header.
Headers
CloudCruise API key for authentication
Path Parameters
The ID of the workflow component
Body
Payload for renaming a workflow component. Does not create a new version.
New display name for the component
100Response
Component renamed successfully
Full workflow component including its latest version's component_data.
Returned by GET /workflow-components/{component_id} and the create endpoint.
Unique identifier for the component
ID of the workspace this component belongs to
Display name of the component
Structural payload for a workflow component: the nodes, edges, and vault schema that compose it. Mirrors the shape used by the workflow visualizer.
Show child attributes
Show child attributes
The latest version number of this component
x >= 1ID of the user who created the component
Optional note describing the latest version's changes
Was this page helpful?

