POST
/
workflow
/
call
/
{workflowId}
curl --request POST \
  --url https://subverseai.com/api/workflow/call/{workflowId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "customer_number": "+912298765432",
  "customer_details": {
    "email": "[email protected]",
    "name": "John Doe",
    "id": "JD75816540"
  },
  "bot_number": "+912298765432",
  "use_case": "test_case",
  "schedule_time": "2025-01-22T08:14:57Z",
  "options": {
    "transcriptLanguage": "hi",
    "allowedOverallInterruptions": "True",
    "allowedInterruptionsInitially": "False",
    "ttsLanguage": "hi",
    "voiceId": "IvLWq57RKibBrqZGpQrC",
    "speed": "2",
    "transferNumber": "+912298765432",
    "communicationMethod": "two_way",
    "dtmfEnabled": "False",
    "initialMessage": "Hi, ${name} how can I assist you today?",
    "additionalContext": "The caller is asking about a refund request submitted yesterday."
  },
  "no_of_retries": 1,
  "retry_after_in_hrs": 1,
  "start_working_hour": "09:00",
  "end_working_hour": "20:00",
  "timezone": "Asia/Kolkata"
}'
{
  "responseCode": 200,
  "message": "Workflow call triggered successfully",
  "data": null
}

Authorizations

​
x-api-key
string
header
required

Authentication header containing API key from SubVerse dashboard.

Path Parameters

​
workflowId
string
required

Unique identifier of the workflow.

Body

application/json

Response

200 - application/json

Returns error or success response

The response is of type object.