Update Call Flow

PUThttps://api.trillet.ai/v1/api/call-flows/{id}

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Path Parameters

idstringrequired

The unique ID of the call flow to update.

Request Body

namestring

New name for the flow.

descriptionstring

Updated description for the call flow (e.g., "Updated description for inbound calls").

directionstring

The direction of the call flow. 'outbound' or 'bidirectional'

isActiveboolean

Whether the call flow is currently active.

isGlobalboolean

Whether this is a global call flow (requires special permissions).

promptTypestringrequired

The type of prompt used in the call flow "simple".

promptstring

The primary prompt for user interaction (used when promptType is 'simple').

welcomeMessagestringdefault: user_initiated

Type of welcome message for the call flow. Possible values: “user_initiated”, “ai_dynamic”, “ai_custom”. Defaults to “user_initiated”.

customWelcomeMessagestring

Custom welcome message text (used when welcomeMessage is 'ai_custom').

dynamicVariableCollectionsarray

Collections of dynamic variables for the call flow.

settingsobject

Configuration settings for the call flow.

webhooksarray

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

_idstring

The unique identifier for the newly created call flow.

workspaceIdstring

The identifier of the workspace where the call flow has been created.

folderIdstring

The identifier of the folder where the call flow is organized.

isGlobalboolean

Whether this is a global call flow.

isPreConfiguredboolean

Whether this call flow is pre-configured.

preConfiguredWorkspaceIdstring

Workspace ID for pre-configured flows.

namestring

The name given to the call flow.

directionstring

The direction configuration of the call flow; can be "inbound", "outbound", or "bidirectional".

descriptionstring

A description of what the call flow is designed to handle.

agentstring

The identifier of the agent associated with this call flow.

promptTypestring

Indicates whether the call flow uses "simple" or "flow" based configuration.

welcomeMessagestring

Welcome message type configuration.

customWelcomeMessagestring

Custom welcome message text if configured.

flowDataobject

The configuration of nodes and edges that define the call routing logic within the flow.

nodesarray

Detailed configuration of the nodes within the call flow.

edgesarray

Configurations of the edges connecting nodes within the call flow.

promptstring

The initial or system prompt used in the call flow.

currentPromptIdstring

ID of the current active prompt version.

gemini_promptstring

Sanitized version of the prompt for Gemini processing.

startNodeIdstring

ID of the starting node for flow-based configurations.

isActiveboolean

Indicates whether the call flow is currently active or inactive.

agentWebhookUrlstring

Webhook URL for agent-related events.

inboundWebhookUrlstring

Webhook URL for inbound call events.

dynamicVariableCollectionsarray

Array of dynamic variable collections configured for the call flow.

locationsarray

Array of location objects for visual flow positioning.

webhooksarray

Array of configured webhooks with their complete configuration.

settingsobject

Configuration settings for various aspects of the call flow, including welcome messages, webhooks, knowledge bases, call settings, and security.

securityobject

Security settings with processed values.

hipaaComplianceboolean

HIPAA compliance status (processed from securityOptOut).

publicAccessboolean

Public access configuration.

createdAtstring

Timestamp when the call flow was created.

updatedAtstring

Timestamp when the call flow was last updated.

{
  "_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"
}