Replace Flow Root
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/replace_flow_root \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"flowPlanId": "<string>",
"root": "<unknown>",
"returnWorkspace": false
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/replace_flow_root"
payload = {
"flowPlanId": "<string>",
"root": "<unknown>",
"returnWorkspace": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({flowPlanId: '<string>', root: '<unknown>', returnWorkspace: false})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/replace_flow_root', 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://gateway.firsttouch.ai/api/public/tools/replace_flow_root",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flowPlanId' => '<string>',
'root' => '<unknown>',
'returnWorkspace' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-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://gateway.firsttouch.ai/api/public/tools/replace_flow_root"
payload := strings.NewReader("{\n \"flowPlanId\": \"<string>\",\n \"root\": \"<unknown>\",\n \"returnWorkspace\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-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.post("https://gateway.firsttouch.ai/api/public/tools/replace_flow_root")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flowPlanId\": \"<string>\",\n \"root\": \"<unknown>\",\n \"returnWorkspace\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/replace_flow_root")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flowPlanId\": \"<string>\",\n \"root\": \"<unknown>\",\n \"returnWorkspace\": false\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}Flow Plans
Replace Flow Root
Requires the admin team role or global admin access. Check get_current_user.toolAccess before calling.
Replace an existing reusable flow-plan root with a complete node tree.
Detailed usage guidance
- Call get_guide with topic=flow_plan_creation before building root JSON, and call get_flow_available_variables before using variables in prompts or expressions.
- When payload.enable_ai_generation=true, at least one applicable content field must be empty or contain square-bracket AI instructions; otherwise the request is rejected.
- Email and InMail check body and subject independently; an inherited email reply subject does not count.
- Set enable_ai_generation=false for finished literal text.
- Do not use this for independent contact chains; use create_contact_sequence for each contact’s first step and add_contact_action for later steps.
- Never use this for the MCP Dynamic Actions flow plan; use create_contact_sequence to create enrollments or add_contact_action to extend them and cancel_flow_enrollments with explicit IDs to cancel them.
- The flow becomes a draft after replacement.
POST
/
api
/
public
/
tools
/
replace_flow_root
Replace Flow Root
curl --request POST \
--url https://gateway.firsttouch.ai/api/public/tools/replace_flow_root \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"flowPlanId": "<string>",
"root": "<unknown>",
"returnWorkspace": false
}
'import requests
url = "https://gateway.firsttouch.ai/api/public/tools/replace_flow_root"
payload = {
"flowPlanId": "<string>",
"root": "<unknown>",
"returnWorkspace": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({flowPlanId: '<string>', root: '<unknown>', returnWorkspace: false})
};
fetch('https://gateway.firsttouch.ai/api/public/tools/replace_flow_root', 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://gateway.firsttouch.ai/api/public/tools/replace_flow_root",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'flowPlanId' => '<string>',
'root' => '<unknown>',
'returnWorkspace' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-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://gateway.firsttouch.ai/api/public/tools/replace_flow_root"
payload := strings.NewReader("{\n \"flowPlanId\": \"<string>\",\n \"root\": \"<unknown>\",\n \"returnWorkspace\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-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.post("https://gateway.firsttouch.ai/api/public/tools/replace_flow_root")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"flowPlanId\": \"<string>\",\n \"root\": \"<unknown>\",\n \"returnWorkspace\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://gateway.firsttouch.ai/api/public/tools/replace_flow_root")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"flowPlanId\": \"<string>\",\n \"root\": \"<unknown>\",\n \"returnWorkspace\": false\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}{
"error": "<string>",
"message": "<string>",
"traceId": "<string>",
"details": {
"currentStatus": "pending"
}
}Body
application/json
Response
Tool result.