Skip to main content
POST
/
v1
/
actions
Create Action
curl --request POST \
  --url https://api.eqho.ai/v1/actions \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "slug": "<string>",
  "instructions": "<string>",
  "messages": {
    "start": "<string>",
    "completed": "<string>",
    "failed": "<string>",
    "delayed": "<string>"
  },
  "minimum_execution_time_milliseconds": 123,
  "delayed_timing_milliseconds": 123,
  "type": "call_transfer",
  "is_async": true,
  "settings": {},
  "execution_type": "live",
  "response_mode": "interactive",
  "execution_order": 123,
  "_id": "<string>",
  "account_id": "<string>",
  "enabled": true,
  "history": {
    "revision": 0,
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "unknown",
    "last_modified_at": "2023-11-07T05:31:56Z",
    "last_modified_by": "unknown"
  }
}'
{
  "name": "<string>",
  "slug": "<string>",
  "instructions": "<string>",
  "messages": {
    "start": "<string>",
    "completed": "<string>",
    "failed": "<string>",
    "delayed": "<string>"
  },
  "minimum_execution_time_milliseconds": 123,
  "delayed_timing_milliseconds": 123,
  "type": "call_transfer",
  "is_async": true,
  "settings": {},
  "execution_type": "live",
  "response_mode": "interactive",
  "execution_order": 123,
  "_id": "<string>",
  "account_id": "<string>",
  "enabled": true,
  "history": {
    "revision": 0,
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "unknown",
    "last_modified_at": "2023-11-07T05:31:56Z",
    "last_modified_by": "unknown"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
name
string
required
​
slug
string
required
​
instructions
string
required
​
type
enum<string>
required
Available options:
call_transfer,
terminate_call,
email,
text,
webhook,
is_zip_allowed,
in_call_data_webhook,
get_current_time,
placeholder,
play_sound,
send_dtmf,
custom_call_transfer,
gcal_appointment_schedule,
gcal_check_busy_time,
gcal_get_free_slots,
gcal_fetch_appointments,
gcal_cancel_appointment,
gcal_update_appointment,
data_extraction,
set_lead_email,
set_lead_names,
set_lead_timezone,
ghl_appointment_schedule,
ghl_get_free_slots,
ghl_get_appointments,
ghl_get_appointments_by_phone,
ghl_get_appointment_details,
ghl_update_appointment,
ghl_cancel_appointment,
ghl_appointment_schedule_v2,
ghl_get_free_slots_v2,
ghl_get_appointments_v2,
ghl_get_appointments_by_phone_v2,
ghl_get_appointment_details_v2,
ghl_update_appointment_v2,
ghl_cancel_appointment_v2
​
settings
object
required
​
messages
object | null
​
minimum_execution_time_milliseconds
integer | null
​
delayed_timing_milliseconds
integer | null
​
is_async
boolean | null
default:false
​
execution_type
enum<string>
Available options:
live,
postcall,
on_call_start
​
response_mode
enum<string>
Available options:
interactive,
silent
​
execution_order
integer | null
​
_id
string | null
​
account_id
string | null
​
enabled
boolean | null
default:true
​
history
object | null

Response

Successful Response

​
name
string
required
​
slug
string
required
​
instructions
string
required
​
type
enum<string>
required
Available options:
call_transfer,
terminate_call,
email,
text,
webhook,
is_zip_allowed,
in_call_data_webhook,
get_current_time,
placeholder,
play_sound,
send_dtmf,
custom_call_transfer,
gcal_appointment_schedule,
gcal_check_busy_time,
gcal_get_free_slots,
gcal_fetch_appointments,
gcal_cancel_appointment,
gcal_update_appointment,
data_extraction,
set_lead_email,
set_lead_names,
set_lead_timezone,
ghl_appointment_schedule,
ghl_get_free_slots,
ghl_get_appointments,
ghl_get_appointments_by_phone,
ghl_get_appointment_details,
ghl_update_appointment,
ghl_cancel_appointment,
ghl_appointment_schedule_v2,
ghl_get_free_slots_v2,
ghl_get_appointments_v2,
ghl_get_appointments_by_phone_v2,
ghl_get_appointment_details_v2,
ghl_update_appointment_v2,
ghl_cancel_appointment_v2
​
settings
object
required
​
messages
object | null
​
minimum_execution_time_milliseconds
integer | null
​
delayed_timing_milliseconds
integer | null
​
is_async
boolean | null
default:false
​
execution_type
enum<string>
Available options:
live,
postcall,
on_call_start
​
response_mode
enum<string>
Available options:
interactive,
silent
​
execution_order
integer | null
​
_id
string | null
​
account_id
string | null
​
enabled
boolean | null
default:true
​
history
object | null