AgenticUniverse - Previously Formi
  1. Pre-Interaction Context
AgenticUniverse - Previously Formi
  • Our Technical Note
    • Why Open AI is not Enough
    • How business Outcomes would Change Radically with AgenticUniverse
    • Our Research
      • STT - Nuances and Insights
      • Solving for STT Constraints
  • Generate Token
    • Login/Generate Token
      POST
  • Agent Configuration
    • Model Configuration
      • Configuration Helpers
        • Supported Providers
        • Supported Models
        • Supported Parameters
      • Get Model Configuration
      • Set Model Configuration
    • State Machine
      • Edge
        • Legacy
          • Create Edge
          • Edge Details
          • Update Edge
          • Delete Edge
        • Update edge properties
        • Get edge details
        • Delete an edge
        • Create an edge (transition) between two states
      • State
        • Create State from Template
        • Get State Information
        • Update State
        • Delete State
      • Get State Machine Structure
    • Prompt Templates
      • Get All Templates
      • Render Template
    • Tools
      • Get Tools List
      • Add Tool
      • Update Tool
      • Delete Tool
    • Get All Agents
      GET
    • Single Agent Details
      GET
    • Create Agent
      POST
    • Update Agent Details
      PUT
    • Enable Dashboard For An Outlet
      POST
    • Disable Dashboard For An Outlet
      POST
    • Get Call queue Sheet ID
      GET
  • Interactions
    • Pre-Interaction Context
      • Schedule an Interaction
        POST
      • Update an Interaction Id
        PUT
      • Delete an Interaction Id
        DELETE
      • Clear all interactions
        POST
      • Get Summarized Interaction Info
        GET
    • Interaction Modalities
      • Video
        • Generation
          • Generate Welcome Video
      • Text
        • Start Interaction
        • Create Response
        • End Interaction
      • Voice
        • Connection Configuration
          • Quickstart
          • Connecting Twilio
          • Connecting Exotel
          • Formi WebSocket Configuration Guide
          • Create a New Connection Vendor
          • Get All Connection Vendors
          • Update a Connection Vendor
          • Delete a Connection Vendor
          • Get Agent's Connection Config
          • Add or Update Agent's Connection Config
    • Post Interaction Configuration
      • Email Destination Configuration
      • Variables CRUD
        • Get all required variables for the outlet with map
        • Modify variable definition for outlet
        • Add a new variable for the outlet
        • DELETE variable for outlet
        • Connect Variable to a destination
      • Destinations CRUD
        • Get all destinations for the outlet
        • Modify Destination for outlet
        • Add a new Destination for the outlet
        • DELETE Destinations for outlet
    • Get Interaction Summary
      GET
    • Resolve an Escalated Interaction
      POST
    • Get the Interaction list
      GET
    • Get Information regarding Single Interaction
      GET
  • Agent Utilisation
    • Get Credits Available
    • Interaction Utilisation
    • Model Utilisation
  • Webhooks
    • Get webhook URL
    • Update webhook URL
    • Get webhook metadata
    • Modify webhook metadata
    • Get reservation ingestion metadata
  • Untitled Endpoint
    POST
  1. Pre-Interaction Context

Update an Interaction Id

Developing
Staging Env
https://staging-api.formi.co.in
Staging Env
https://staging-api.formi.co.in
PUT
https://staging-api.formi.co.in
/v2/interactions/{interaction_id}
Last modified:2025-07-04 12:06:00
Maintainer:Not configured
Modifies an existing interaction, such as changing the scheduled time or updating metadata.

Request

Path Params

Header Params

Body Params application/json

Example
{
    "interaction_id": 0,
    "interaction_flow_type": "AUTO_START",
    "interaction_modality": "CALL",
    "interaction_status": "scheduled",
    "scheduled_time": "2019-08-24T14:15:22Z",
    "ended_time": "2019-08-24T14:15:22Z",
    "scheduled_time_timezone": "string",
    "variables": {
        "property1": "string",
        "property2": "string"
    },
    "messages": [
        {
            "sender": "agent",
            "message": "string",
            "timestamp": "2019-08-24T14:15:22Z"
        }
    ],
    "transcript": "string",
    "customer_details": {
        "customer_name": "string",
        "customer_email": "user@example.com",
        "customer_phone_number": "string"
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://staging-api.formi.co.in/v2/interactions/454' \
--header 'token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTAwLCJ0eXBlIjoiT1VUTEVUIiwibmFtZSI6IkVrb3N0YXkifQ.7ElxWvnf5p3_1MuXd5q-XyxFXXXHUFLgHs4YRgWuqbc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "interaction_id": 0,
    "interaction_flow_type": "AUTO_START",
    "interaction_modality": "CALL",
    "interaction_status": "scheduled",
    "scheduled_time": "2019-08-24T14:15:22Z",
    "ended_time": "2019-08-24T14:15:22Z",
    "scheduled_time_timezone": "string",
    "variables": {
        "property1": "string",
        "property2": "string"
    },
    "messages": [
        {
            "sender": "agent",
            "message": "string",
            "timestamp": "2019-08-24T14:15:22Z"
        }
    ],
    "transcript": "string",
    "customer_details": {
        "customer_name": "string",
        "customer_email": "user@example.com",
        "customer_phone_number": "string"
    }
}'

Responses

🟢200Success
application/json
Body

Example
{
    "success": true,
    "message": "Interaction updated successfully",
    "payload": {
        "interaction_id": 454,
        "updated_status": "ended"
    }
}
Modified at 2025-07-04 12:06:00
Previous
Schedule an Interaction
Next
Delete an Interaction Id
Built with