API key used for authenticating requests to the API.
Workspace identifier for the API.
Path Parameters The unique ID of the call flow to update.
Request Body Updated description for the call flow (e.g., “Updated description for inbound calls”).
The direction of the call flow. ‘outbound’ or ‘bidirectional’
Whether the call flow is currently active.
Whether this is a global call flow (requires special permissions).
The type of prompt used in the call flow “simple”.
The primary prompt for user interaction (used when promptType is ‘simple’).
welcomeMessage
string
default: "user_initiated"
Type of welcome message for the call flow. Possible values: “user_initiated”, “ai_dynamic”, “ai_custom”. Defaults to “user_initiated”.
Custom welcome message text (used when welcomeMessage is ‘ai_custom’).
dynamicVariableCollections
Collections of dynamic variables for the call flow. Show dynamicVariableCollections
Unique identifier for the variable collection.
Name of the variable collection.
Whether this is the default variable collection.
Array of key-value pairs. Configuration settings for the call flow. enableHumanLikeVoiceAndTone
Whether to enable human-like voice and tone.
Delay in seconds before playing the welcome message.
Default customer location (e.g., “new york”).
Whether to use context from previous calls.
Delay (in seconds) before responding.
Whether working hours logic is enabled.
Start time for working hours, e.g., “08:00”.
End time for working hours, e.g., “20:00”.
Timezone for working hours, e.g., “America/New_York”.
Automated reply for out-of-hours calls.
Whether HIPAA compliance is required. When enabled, automatically disables call recording.
Whether public access is allowed.
Maximum call duration (in seconds).
Timeout (in seconds) for ending a call if no audio is detected.
Whether to enable Trillet voice guard protection.
Array of reminder messages to be played during calls.
Array of knowledge base files associated with the call flow. Name of the knowledge base file.
Storage key for the file.
Array of knowledge base IDs referenced by the call flow.
Array of transfer configurations for the call flow.
List of webhooks to be added to the call flow. A new webhook will be created for each entry in the array, regardless of the name or if it already exists. The name of the webhook (e.g., “Booking”).
A brief description of what this webhook does (e.g., “Booking request webhook”).
HTTP method for the webhook request.
Headers to be included in the webhook request.
The webhook request body. Can include variable placeholders.
A list of variables used in the webhook body for dynamic content generation. The name of the variable.
A description of the variable.
Variables to extract from the webhook response. Name of the response variable.
JSON path to extract the value from the response.
Description of the response variable.
Whether this webhook is in testing mode.
Mock response for testing purposes.
Text to be spoken when this webhook is triggered.
These endCallOnSilence and maxCallDuration settings are recommended to be sent for optimal API performance, though they are not strictly required.
Response Fields The unique identifier for the newly created call flow.
The identifier of the workspace where the call flow has been created.
The identifier of the folder where the call flow is organized.
Whether this is a global call flow.
Whether this call flow is pre-configured.
Workspace ID for pre-configured flows.
The name given to the call flow.
The direction configuration of the call flow; can be “inbound”, “outbound”, or “bidirectional”.
A description of what the call flow is designed to handle.
The identifier of the agent associated with this call flow.
Indicates whether the call flow uses “simple” or “flow” based configuration.
Welcome message type configuration.
Custom welcome message text if configured.
The configuration of nodes and edges that define the call routing logic within the flow. Detailed configuration of the nodes within the call flow.
Configurations of the edges connecting nodes within the call flow.
The initial or system prompt used in the call flow.
ID of the current active prompt version.
Sanitized version of the prompt for Gemini processing.
ID of the starting node for flow-based configurations.
Indicates whether the call flow is currently active or inactive.
Webhook URL for agent-related events.
Webhook URL for inbound call events.
dynamicVariableCollections
Array of dynamic variable collections configured for the call flow.
Array of location objects for visual flow positioning.
Array of configured webhooks with their complete configuration.
Configuration settings for various aspects of the call flow, including welcome messages, webhooks, knowledge bases, call settings, and security. Security settings with processed values. HIPAA compliance status (processed from securityOptOut).
Public access configuration.
Timestamp when the call flow was created.
Timestamp when the call flow was last updated.
The version number of the call flow document.
{ "_id" : "676b8e123456789012345678" , "workspaceId" : "6764d172953253138a3a70f4" , "folderId" : null , "isGlobal" : false , "isPreConfigured" : false , "preConfiguredWorkspaceId" : null , "name" : "Customer Support Flow" , "direction" : "inbound" , "description" : "Handles inbound support calls" , "agent" : "676b8e123456789012345679" , "promptType" : "simple" , "welcomeMessage" : "user_initiated" , "customWelcomeMessage" : "" , "flowData" : { "nodes" : [ { "id" : "node1" , "type" : "start" , "data" : { "prompt" : "Welcome to our support line. How can I help you?" } } ], "edges" : [] }, "prompt" : "Keep the conversation short and friendly." , "currentPromptId" : "676b8e123456789012345680" , "promptVersions" : [ { "_id" : "676b8e123456789012345680" , "name" : "Prompt Version - 1/15/2025, 3:00:00 PM" , "prompt" : "Keep the conversation short and friendly." , "metadata" : { "notes" : "" }, "createdAt" : "2025-01-15T15:00:00.000Z" , "updatedAt" : "2025-01-15T15:00:00.000Z" } ], "gemini_prompt" : "Keep the conversation short and friendly." , "startNodeId" : null , "isActive" : true , "agentWebhookUrl" : "" , "inboundWebhookUrl" : "" , "dynamicVariableCollections" : [], "locations" : [], "webhooks" : [], "settings" : { "welcomeMessage" : "user_initiated" , "customWelcomeMessage" : "" , "enableHumanLikeVoiceAndTone" : false , "welcomeMessageDelay" : 0 , "webhooks" : { "agent" : "" , "inbound" : "" }, "customerLocation" : "new york" , "transfers" : [], "knowledgeBases" : [], "utilizePriorCallsContext" : false , "callSettings" : { "trilletVoiceGuard" : true , "reminderMessages" : [] }, "security" : { "hipaaCompliance" : false , "publicAccess" : false } }, "createdAt" : "2025-01-15T15:00:00.000Z" , "updatedAt" : "2025-01-15T15:00:00.000Z" , "__v" : 0 } 
