Skip to main content
PUT
Update Call Flow

Headers

string
required
API key used for authenticating requests to the API.
string
required
Workspace identifier for the API.

Path Parameters

string
required
The unique ID of the call flow to update.

Request Body

string
New name for the flow.
string
Updated description for the call flow (e.g., “Updated description for inbound calls”).
string
The direction of the call flow. ‘outbound’ or ‘bidirectional’
boolean
Whether the call flow is currently active.
boolean
Whether this is a global call flow (requires special permissions).
string
required
The type of prompt used in the call flow “simple”.
string
The primary prompt for user interaction (used when promptType is ‘simple’).
string
default:"user_initiated"
Type of welcome message for the call flow. Possible values: “user_initiated”, “ai_dynamic”, “ai_custom”. Defaults to “user_initiated”.
string
Custom welcome message text (used when welcomeMessage is ‘ai_custom’).
array
Collections of dynamic variables for the call flow.
object
Configuration settings for the call flow.
array
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.
These endCallOnSilence and maxCallDuration settings are recommended to be sent for optimal API performance, though they are not strictly required.

Response Fields

string
The unique identifier for the newly created call flow.
string
The identifier of the workspace where the call flow has been created.
string
The identifier of the folder where the call flow is organized.
boolean
Whether this is a global call flow.
boolean
Whether this call flow is pre-configured.
string
Workspace ID for pre-configured flows.
string
The name given to the call flow.
string
The direction configuration of the call flow; can be “inbound”, “outbound”, or “bidirectional”.
string
A description of what the call flow is designed to handle.
string
The identifier of the agent associated with this call flow.
string
Indicates whether the call flow uses “simple” or “flow” based configuration.
string
Welcome message type configuration.
string
Custom welcome message text if configured.
object
The configuration of nodes and edges that define the call routing logic within the flow.
array
Detailed configuration of the nodes within the call flow.
array
Configurations of the edges connecting nodes within the call flow.
string
The initial or system prompt used in the call flow.
string
ID of the current active prompt version.
string
Sanitized version of the prompt for Gemini processing.
string
ID of the starting node for flow-based configurations.
boolean
Indicates whether the call flow is currently active or inactive.
string
Webhook URL for agent-related events.
string
Webhook URL for inbound call events.
array
Array of dynamic variable collections configured for the call flow.
array
Array of location objects for visual flow positioning.
array
Array of configured webhooks with their complete configuration.
object
Configuration settings for various aspects of the call flow, including welcome messages, webhooks, knowledge bases, call settings, and security.
object
Security settings with processed values.
boolean
HIPAA compliance status (processed from securityOptOut).
boolean
Public access configuration.
string
Timestamp when the call flow was created.
string
Timestamp when the call flow was last updated.