REretellai

PATCH /update-conversation-flow-component/{conversation_flow_component_id}

Changed on

Update an existing shared conversation flow component

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Path parameters

conversation_flow_component_idstring required

ID of the component to update

Request body

namestring

Name of the component

flex_modeboolean nullable

If enabled, the whole component will be converted as a Single Prompt agent.

start_node_idstring nullable

ID of the starting node

Example request

{
  "name": "Customer Information Collector",
  "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": [
    {
      "headers": {
        "Authorization": "Bearer 1234567890"
      },
      "query_params": {
        "index": "1",
        "key": "value"
      }
    }
  ],
  "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
      }
    }
  ]
}

Response

Successfully updated conversation flow component

namestring required

Name of the component

flex_modeboolean nullable

If enabled, the whole component will be converted as a Single Prompt agent.

start_node_idstring nullable

ID of the starting node

conversation_flow_component_idstring required

Unique identifier for the component

user_modified_timestampinteger required

Timestamp of last user modification

linked_conversation_flow_idsstring[]

IDs of conversation flows linked to this shared component

Example response

{
  "name": "Customer Information Collector",
  "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": [
    {
      "headers": {
        "Authorization": "Bearer 1234567890"
      },
      "query_params": {
        "index": "1",
        "key": "value"
      }
    }
  ],
  "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
      }
    }
  ]
}

Changes

  • f2ea6eb18117Revision changes
    • info

      added the new optional request property ///////////////

    • info

      added the new optional request property ///////////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the optional property /////////////////////// to the response with the status

    • info

      added the optional property /////////////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

    • info

      added the optional property ///////////////// to the response with the status

  • 6e88894224e1Revision changes
    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the //////////////////////// response property for the response status

    • warning

      added the new gpt-6.1-terra enum value to the ///////////////////////// response property for the response status

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property ////////////////

    • info

      added the new gpt-6.1-terra enum value to the request property /////////////////