Schedule an Interaction

Developing

Staging Env

https://staging-api.formi.co.in

POST

/v2/interactions/schedule

Last modified:2025-07-22 07:03:42

Maintainer:Not configured

Adds a new interaction to the queue with all required context and scheduling information.

Request

Header Params

Body Params application/json

Example

{
  "interactions": [
    {
      "contact_id": "8840169389",
      "customer_name": "Anubhav Rai",
      "interaction_modality": "CALL",
      "type": "BIZ_START",
      "scheduled_time": "2025-07-21 09:02:12",
      "scheduled_time_timezone": "Asia/Kolkata",
      "agent_id": 64,
      "phone_number": "9701966915",
      "email": "daksesh@gmail.com",
      "contact_stage": "NEW_INTERACTION",
      "variables": {
        "current_company_of_the_prospect": "Google",
        "highest_education_qualification": "Completed B.tech from IIT Delhi in 2020",
        "prospect_age": "26",
        "prospect_name": "Tarun",
        "if_prospect_is_enjoying_their_current_job": "the project got de-risked because of the legal issue, and they are laying me off",
        "years_of_experience": "2",
        "crm_id": "124343634566565"
      },
      "metadata": {
        "crm_id": "124343634566565",
        "metadata_test" : "abcxyz-hello123"
      },
      "attempt_config": {
        "attempt_number": 0,
        "attempt_interval": 2,
        "max_attempts": 10
      },
      "connection_provider" : "exotel"
    } 
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://staging-api.formi.co.in/v2/interactions/schedule' \
--header 'token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTAwLCJ0eXBlIjoiT1VUTEVUIiwibmFtZSI6IkVrb3N0YXkifQ.7ElxWvnf5p3_1MuXd5q-XyxFXXXHUFLgHs4YRgWuqbc' \
--header 'Content-Type: application/json' \
--data-raw '{
  "interactions": [
    {
      "contact_id": "8840169389",
      "customer_name": "Anubhav Rai",
      "interaction_modality": "CALL",
      "type": "BIZ_START",
      "scheduled_time": "2025-07-21 09:02:12",
      "scheduled_time_timezone": "Asia/Kolkata",
      "agent_id": 64,
      "phone_number": "9701966915",
      "email": "daksesh@gmail.com",
      "contact_stage": "NEW_INTERACTION",
      "variables": {
        "current_company_of_the_prospect": "Google",
        "highest_education_qualification": "Completed B.tech from IIT Delhi in 2020",
        "prospect_age": "26",
        "prospect_name": "Tarun",
        "if_prospect_is_enjoying_their_current_job": "the project got de-risked because of the legal issue, and they are laying me off",
        "years_of_experience": "2",
        "crm_id": "124343634566565"
      },
      "metadata": {
        "crm_id": "124343634566565",
        "metadata_test" : "abcxyz-hello123"
      },
      "attempt_config": {
        "attempt_number": 0,
        "attempt_interval": 2,
        "max_attempts": 10
      },
      "connection_provider" : "exotel"
    } 
  ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "message": "1 interactions scheduled successfully, 0 failed",
    "payload": {
        "interactions": [
            {
                "order": 1,
                "status": "success",
                "contact_id": "9988776655",
                "customer_name": "John Doe",
                "scheduled_time": "2025-07-03 10:00:00",
                "interaction_id": 454
            }
        ],
        "successful_count": 1,
        "failed_count": 0,
        "queue_size": 12
    }
}

Modified at 2025-07-22 07:03:42

Pre-Interaction Context

Update an Interaction Id