API documentation

POST /key_press_flows

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/key_press_flows

Create Key Press Flow.

Creates a Key Press Flow that ties a specific IVR key press to a key press flow group, along with token and call control action assignments.

Params

Param name	Description
key_press_flow_group_id Optional Blank value allowed	Key Press Flow Group Must be a String
key_press Optional Blank value allowed	The key that runs this flow: 0-9, *, #, or any to match any other key the caller presses. Must be a String
description Optional Blank value allowed	Description Must be a String
continue_call_routing Optional Blank value allowed	When enabled, pressing this key while connected to an external agent hangs up the current buyer legs and searches for the next matching call flow to connect the lead to a real buyer, instead of running call_disposition_id and call_control_action_ids. Must be a boolean value: 1, true, yes, on, 0, false, no, off
call_disposition_id Optional Blank value allowed	The disposition applied to the call when this key is pressed, instead of ending the call routing search. Must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions
call_control_action_ids Optional Blank value allowed	The actions to run when this key is pressed, instead of ending the call routing search. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Control Action. Refer to: /api/docs/1.0/call_control_actions
buyer_conference_time_elapsed_seconds_limit Optional Blank value allowed	Only allows this key press once the buyer has been connected for at least this many seconds. Must be a decimal number.
token_value_ids Optional Blank value allowed	Only uses this Key Press Flow for calls matching these token values. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
attribution_token_value_ids Optional Blank value allowed	When this Key Press Flow’s actions run, the call will be tagged with these token values. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`
record_token_additional_list Optional Blank value allowed	Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs. Must be a valid list of tokens. Example tokens: `buyer_interest:loan,another_token:value`

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/key_press_flows/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "key_press_flow_group_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
  "key_press": "1",
  "description": "Key press flow created for API documentation examples"
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "key_press_flow": {
    "id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "type": "KeyPressFlow",
    "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/key_press_flows/a09e6bca-255b-4217-af73-cb9601c80217",
    "routes_edit_path": "/key_press_flows/a09e6bca-255b-4217-af73-cb9601c80217/edit",
    "external_record_id": null,
    "company_id": 10001,
    "key_press_flow_group_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "key_press": "1",
    "call_control_action_ids": null,
    "sortable_order": -4,
    "description": "Key press flow created for API documentation examples",
    "webhook_actions_count": 0,
    "call_disposition_id": null,
    "continue_call_routing": false,
    "buyer_conference_time_elapsed_seconds_limit": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_id": null,
    "record_token_additional_data_count": 0,
    "record_token_additional_data": []
  },
  "metadata": {
    "root": "key_press_flow"
  }
}