Conversation Flow Subflows
Update Conversation Flow Subflow
Update an existing shared conversation flow component
PATCH
/
update-conversation-flow-component
/
{conversation_flow_component_id}
JavaScript
import Retell from 'retell-sdk';
const client = new Retell({
apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted
});
const conversationFlowComponentResponse = await client.conversationFlowComponent.update(
'conversation_flow_component_id',
);
console.log(conversationFlowComponentResponse.conversation_flow_component_id);import os
from retell import Retell
client = Retell(
api_key=os.environ.get("RETELL_API_KEY"), # This is the default and can be omitted
)
conversation_flow_component_response = client.conversation_flow_component.update(
conversation_flow_component_id="conversation_flow_component_id",
)
print(conversation_flow_component_response.conversation_flow_component_id)curl --request PATCH \
--url https://api.retellai.com/update-conversation-flow-component/{conversation_flow_component_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Customer Information Collector",
"flex_mode": false,
"tools": [
{
"type": "custom",
"name": "get_customer_info",
"description": "Get customer information from database",
"tool_id": "tool_001",
"url": "https://api.example.com/customer",
"method": "GET"
}
],
"mcps": [
{
"name": "<string>",
"url": "<string>",
"headers": {
"Authorization": "Bearer 1234567890"
},
"query_params": {
"index": "1",
"key": "value"
},
"timeout_ms": 123
}
],
"nodes": [
{
"id": "collect_info",
"type": "conversation",
"instruction": {
"type": "prompt",
"text": "Ask the customer for their name and contact information."
}
}
],
"start_node_id": "collect_info",
"begin_tag_display_position": {
"x": 100,
"y": 200
},
"notes": [
{
"id": "note_abc123",
"content": "Remember to handle edge cases here.",
"display_position": {
"x": 300,
"y": 150
},
"size": {
"width": 200,
"height": 100
}
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.retellai.com/update-conversation-flow-component/{conversation_flow_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' => 'Customer Information Collector',
'flex_mode' => false,
'tools' => [
[
'type' => 'custom',
'name' => 'get_customer_info',
'description' => 'Get customer information from database',
'tool_id' => 'tool_001',
'url' => 'https://api.example.com/customer',
'method' => 'GET'
]
],
'mcps' => [
[
'name' => '<string>',
'url' => '<string>',
'headers' => [
'Authorization' => 'Bearer 1234567890'
],
'query_params' => [
'index' => '1',
'key' => 'value'
],
'timeout_ms' => 123
]
],
'nodes' => [
[
'id' => 'collect_info',
'type' => 'conversation',
'instruction' => [
'type' => 'prompt',
'text' => 'Ask the customer for their name and contact information.'
]
]
],
'start_node_id' => 'collect_info',
'begin_tag_display_position' => [
'x' => 100,
'y' => 200
],
'notes' => [
[
'id' => 'note_abc123',
'content' => 'Remember to handle edge cases here.',
'display_position' => [
'x' => 300,
'y' => 150
],
'size' => [
'width' => 200,
'height' => 100
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.retellai.com/update-conversation-flow-component/{conversation_flow_component_id}"
payload := strings.NewReader("{\n \"name\": \"Customer Information Collector\",\n \"flex_mode\": false,\n \"tools\": [\n {\n \"type\": \"custom\",\n \"name\": \"get_customer_info\",\n \"description\": \"Get customer information from database\",\n \"tool_id\": \"tool_001\",\n \"url\": \"https://api.example.com/customer\",\n \"method\": \"GET\"\n }\n ],\n \"mcps\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {\n \"Authorization\": \"Bearer 1234567890\"\n },\n \"query_params\": {\n \"index\": \"1\",\n \"key\": \"value\"\n },\n \"timeout_ms\": 123\n }\n ],\n \"nodes\": [\n {\n \"id\": \"collect_info\",\n \"type\": \"conversation\",\n \"instruction\": {\n \"type\": \"prompt\",\n \"text\": \"Ask the customer for their name and contact information.\"\n }\n }\n ],\n \"start_node_id\": \"collect_info\",\n \"begin_tag_display_position\": {\n \"x\": 100,\n \"y\": 200\n },\n \"notes\": [\n {\n \"id\": \"note_abc123\",\n \"content\": \"Remember to handle edge cases here.\",\n \"display_position\": {\n \"x\": 300,\n \"y\": 150\n },\n \"size\": {\n \"width\": 200,\n \"height\": 100\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.retellai.com/update-conversation-flow-component/{conversation_flow_component_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Customer Information Collector\",\n \"flex_mode\": false,\n \"tools\": [\n {\n \"type\": \"custom\",\n \"name\": \"get_customer_info\",\n \"description\": \"Get customer information from database\",\n \"tool_id\": \"tool_001\",\n \"url\": \"https://api.example.com/customer\",\n \"method\": \"GET\"\n }\n ],\n \"mcps\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {\n \"Authorization\": \"Bearer 1234567890\"\n },\n \"query_params\": {\n \"index\": \"1\",\n \"key\": \"value\"\n },\n \"timeout_ms\": 123\n }\n ],\n \"nodes\": [\n {\n \"id\": \"collect_info\",\n \"type\": \"conversation\",\n \"instruction\": {\n \"type\": \"prompt\",\n \"text\": \"Ask the customer for their name and contact information.\"\n }\n }\n ],\n \"start_node_id\": \"collect_info\",\n \"begin_tag_display_position\": {\n \"x\": 100,\n \"y\": 200\n },\n \"notes\": [\n {\n \"id\": \"note_abc123\",\n \"content\": \"Remember to handle edge cases here.\",\n \"display_position\": {\n \"x\": 300,\n \"y\": 150\n },\n \"size\": {\n \"width\": 200,\n \"height\": 100\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.retellai.com/update-conversation-flow-component/{conversation_flow_component_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Customer Information Collector\",\n \"flex_mode\": false,\n \"tools\": [\n {\n \"type\": \"custom\",\n \"name\": \"get_customer_info\",\n \"description\": \"Get customer information from database\",\n \"tool_id\": \"tool_001\",\n \"url\": \"https://api.example.com/customer\",\n \"method\": \"GET\"\n }\n ],\n \"mcps\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {\n \"Authorization\": \"Bearer 1234567890\"\n },\n \"query_params\": {\n \"index\": \"1\",\n \"key\": \"value\"\n },\n \"timeout_ms\": 123\n }\n ],\n \"nodes\": [\n {\n \"id\": \"collect_info\",\n \"type\": \"conversation\",\n \"instruction\": {\n \"type\": \"prompt\",\n \"text\": \"Ask the customer for their name and contact information.\"\n }\n }\n ],\n \"start_node_id\": \"collect_info\",\n \"begin_tag_display_position\": {\n \"x\": 100,\n \"y\": 200\n },\n \"notes\": [\n {\n \"id\": \"note_abc123\",\n \"content\": \"Remember to handle edge cases here.\",\n \"display_position\": {\n \"x\": 300,\n \"y\": 150\n },\n \"size\": {\n \"width\": 200,\n \"height\": 100\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "Customer Information Collector",
"nodes": [
{
"id": "collect_info",
"type": "conversation",
"instruction": {
"type": "prompt",
"text": "Ask the customer for their name and contact information."
}
}
],
"conversation_flow_component_id": "<string>",
"user_modified_timestamp": 123,
"flex_mode": false,
"tools": [
{
"type": "custom",
"name": "get_customer_info",
"description": "Get customer information from database",
"tool_id": "tool_001",
"url": "https://api.example.com/customer",
"method": "GET"
}
],
"mcps": [
{
"name": "<string>",
"url": "<string>",
"headers": {
"Authorization": "Bearer 1234567890"
},
"query_params": {
"index": "1",
"key": "value"
},
"timeout_ms": 123
}
],
"start_node_id": "collect_info",
"begin_tag_display_position": {
"x": 100,
"y": 200
},
"notes": [
{
"id": "note_abc123",
"content": "Remember to handle edge cases here.",
"display_position": {
"x": 300,
"y": 150
},
"size": {
"width": 200,
"height": 100
}
}
],
"linked_conversation_flow_ids": [
"<string>"
]
}{
"status": "error",
"message": "Invalid request format, please check API reference."
}{
"status": "error",
"message": "API key is missing or invalid."
}{
"status": "error",
"message": "The requested resource was not found."
}{
"status": "error",
"message": "Precondition failed for conditional update."
}{
"status": "error",
"message": "Account rate limited, please throttle your requests."
}{
"status": "error",
"message": "An unexpected server error occurred."
}Authorizations
Body
application/json
Nodes that make up the component
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
Show child attributes
Show child attributes
Example:
[
{
"id": "collect_info",
"type": "conversation",
"instruction": {
"type": "prompt",
"text": "Ask the customer for their name and contact information."
}
}
]
Response
Successfully updated conversation flow component
Nodes that make up the component
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
Show child attributes
Show child attributes
Example:
[
{
"id": "collect_info",
"type": "conversation",
"instruction": {
"type": "prompt",
"text": "Ask the customer for their name and contact information."
}
}
]
Was this page helpful?
⌘I
JavaScript
import Retell from 'retell-sdk';
const client = new Retell({
apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted
});
const conversationFlowComponentResponse = await client.conversationFlowComponent.update(
'conversation_flow_component_id',
);
console.log(conversationFlowComponentResponse.conversation_flow_component_id);import os
from retell import Retell
client = Retell(
api_key=os.environ.get("RETELL_API_KEY"), # This is the default and can be omitted
)
conversation_flow_component_response = client.conversation_flow_component.update(
conversation_flow_component_id="conversation_flow_component_id",
)
print(conversation_flow_component_response.conversation_flow_component_id)curl --request PATCH \
--url https://api.retellai.com/update-conversation-flow-component/{conversation_flow_component_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Customer Information Collector",
"flex_mode": false,
"tools": [
{
"type": "custom",
"name": "get_customer_info",
"description": "Get customer information from database",
"tool_id": "tool_001",
"url": "https://api.example.com/customer",
"method": "GET"
}
],
"mcps": [
{
"name": "<string>",
"url": "<string>",
"headers": {
"Authorization": "Bearer 1234567890"
},
"query_params": {
"index": "1",
"key": "value"
},
"timeout_ms": 123
}
],
"nodes": [
{
"id": "collect_info",
"type": "conversation",
"instruction": {
"type": "prompt",
"text": "Ask the customer for their name and contact information."
}
}
],
"start_node_id": "collect_info",
"begin_tag_display_position": {
"x": 100,
"y": 200
},
"notes": [
{
"id": "note_abc123",
"content": "Remember to handle edge cases here.",
"display_position": {
"x": 300,
"y": 150
},
"size": {
"width": 200,
"height": 100
}
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.retellai.com/update-conversation-flow-component/{conversation_flow_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' => 'Customer Information Collector',
'flex_mode' => false,
'tools' => [
[
'type' => 'custom',
'name' => 'get_customer_info',
'description' => 'Get customer information from database',
'tool_id' => 'tool_001',
'url' => 'https://api.example.com/customer',
'method' => 'GET'
]
],
'mcps' => [
[
'name' => '<string>',
'url' => '<string>',
'headers' => [
'Authorization' => 'Bearer 1234567890'
],
'query_params' => [
'index' => '1',
'key' => 'value'
],
'timeout_ms' => 123
]
],
'nodes' => [
[
'id' => 'collect_info',
'type' => 'conversation',
'instruction' => [
'type' => 'prompt',
'text' => 'Ask the customer for their name and contact information.'
]
]
],
'start_node_id' => 'collect_info',
'begin_tag_display_position' => [
'x' => 100,
'y' => 200
],
'notes' => [
[
'id' => 'note_abc123',
'content' => 'Remember to handle edge cases here.',
'display_position' => [
'x' => 300,
'y' => 150
],
'size' => [
'width' => 200,
'height' => 100
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.retellai.com/update-conversation-flow-component/{conversation_flow_component_id}"
payload := strings.NewReader("{\n \"name\": \"Customer Information Collector\",\n \"flex_mode\": false,\n \"tools\": [\n {\n \"type\": \"custom\",\n \"name\": \"get_customer_info\",\n \"description\": \"Get customer information from database\",\n \"tool_id\": \"tool_001\",\n \"url\": \"https://api.example.com/customer\",\n \"method\": \"GET\"\n }\n ],\n \"mcps\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {\n \"Authorization\": \"Bearer 1234567890\"\n },\n \"query_params\": {\n \"index\": \"1\",\n \"key\": \"value\"\n },\n \"timeout_ms\": 123\n }\n ],\n \"nodes\": [\n {\n \"id\": \"collect_info\",\n \"type\": \"conversation\",\n \"instruction\": {\n \"type\": \"prompt\",\n \"text\": \"Ask the customer for their name and contact information.\"\n }\n }\n ],\n \"start_node_id\": \"collect_info\",\n \"begin_tag_display_position\": {\n \"x\": 100,\n \"y\": 200\n },\n \"notes\": [\n {\n \"id\": \"note_abc123\",\n \"content\": \"Remember to handle edge cases here.\",\n \"display_position\": {\n \"x\": 300,\n \"y\": 150\n },\n \"size\": {\n \"width\": 200,\n \"height\": 100\n }\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.retellai.com/update-conversation-flow-component/{conversation_flow_component_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Customer Information Collector\",\n \"flex_mode\": false,\n \"tools\": [\n {\n \"type\": \"custom\",\n \"name\": \"get_customer_info\",\n \"description\": \"Get customer information from database\",\n \"tool_id\": \"tool_001\",\n \"url\": \"https://api.example.com/customer\",\n \"method\": \"GET\"\n }\n ],\n \"mcps\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {\n \"Authorization\": \"Bearer 1234567890\"\n },\n \"query_params\": {\n \"index\": \"1\",\n \"key\": \"value\"\n },\n \"timeout_ms\": 123\n }\n ],\n \"nodes\": [\n {\n \"id\": \"collect_info\",\n \"type\": \"conversation\",\n \"instruction\": {\n \"type\": \"prompt\",\n \"text\": \"Ask the customer for their name and contact information.\"\n }\n }\n ],\n \"start_node_id\": \"collect_info\",\n \"begin_tag_display_position\": {\n \"x\": 100,\n \"y\": 200\n },\n \"notes\": [\n {\n \"id\": \"note_abc123\",\n \"content\": \"Remember to handle edge cases here.\",\n \"display_position\": {\n \"x\": 300,\n \"y\": 150\n },\n \"size\": {\n \"width\": 200,\n \"height\": 100\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.retellai.com/update-conversation-flow-component/{conversation_flow_component_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Customer Information Collector\",\n \"flex_mode\": false,\n \"tools\": [\n {\n \"type\": \"custom\",\n \"name\": \"get_customer_info\",\n \"description\": \"Get customer information from database\",\n \"tool_id\": \"tool_001\",\n \"url\": \"https://api.example.com/customer\",\n \"method\": \"GET\"\n }\n ],\n \"mcps\": [\n {\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"headers\": {\n \"Authorization\": \"Bearer 1234567890\"\n },\n \"query_params\": {\n \"index\": \"1\",\n \"key\": \"value\"\n },\n \"timeout_ms\": 123\n }\n ],\n \"nodes\": [\n {\n \"id\": \"collect_info\",\n \"type\": \"conversation\",\n \"instruction\": {\n \"type\": \"prompt\",\n \"text\": \"Ask the customer for their name and contact information.\"\n }\n }\n ],\n \"start_node_id\": \"collect_info\",\n \"begin_tag_display_position\": {\n \"x\": 100,\n \"y\": 200\n },\n \"notes\": [\n {\n \"id\": \"note_abc123\",\n \"content\": \"Remember to handle edge cases here.\",\n \"display_position\": {\n \"x\": 300,\n \"y\": 150\n },\n \"size\": {\n \"width\": 200,\n \"height\": 100\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "Customer Information Collector",
"nodes": [
{
"id": "collect_info",
"type": "conversation",
"instruction": {
"type": "prompt",
"text": "Ask the customer for their name and contact information."
}
}
],
"conversation_flow_component_id": "<string>",
"user_modified_timestamp": 123,
"flex_mode": false,
"tools": [
{
"type": "custom",
"name": "get_customer_info",
"description": "Get customer information from database",
"tool_id": "tool_001",
"url": "https://api.example.com/customer",
"method": "GET"
}
],
"mcps": [
{
"name": "<string>",
"url": "<string>",
"headers": {
"Authorization": "Bearer 1234567890"
},
"query_params": {
"index": "1",
"key": "value"
},
"timeout_ms": 123
}
],
"start_node_id": "collect_info",
"begin_tag_display_position": {
"x": 100,
"y": 200
},
"notes": [
{
"id": "note_abc123",
"content": "Remember to handle edge cases here.",
"display_position": {
"x": 300,
"y": 150
},
"size": {
"width": 200,
"height": 100
}
}
],
"linked_conversation_flow_ids": [
"<string>"
]
}{
"status": "error",
"message": "Invalid request format, please check API reference."
}{
"status": "error",
"message": "API key is missing or invalid."
}{
"status": "error",
"message": "The requested resource was not found."
}{
"status": "error",
"message": "Precondition failed for conditional update."
}{
"status": "error",
"message": "Account rate limited, please throttle your requests."
}{
"status": "error",
"message": "An unexpected server error occurred."
}
