API documentation

GET /text_message_flows

Authorization Required

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

List SMS Flow records.

Returns the SMS Flows configured on the account. An SMS Flow matches inbound text message replies against a pattern and applies token values or an automated reply.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id name context_menu_name company_id user_id sortable_order description template_description template_enabled template_tier offer_id parse_value_with_expression value_formatter value_expression use_flow_when_pattern_matches record_token_filter_id token_value_ids request_a_response response_message contact_field_assign_id contact_field_validate_id text_message_flow_id assert_acceptable_with_contact_field response_message_when_unacceptable record_token_additional_id attribution_token_value_ids outgoing_webhook_ids text_message_flows_count process_response_with_sms_flow_type wait_for_response_seconds valid_responses_csv record_token_filter_data_count record_token_filter_data record_token_additional_data_count record_token_additional_data Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/text_message_flows/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "text_message_flows": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "TextMessageFlow",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "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": null,
      "routes_edit_path": "/text_message_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "name": "Quote Request SMS",
      "context_menu_name": "Quote Request SMS",
      "company_id": 10001,
      "user_id": null,
      "sortable_order": -5,
      "description": "Quote Request SMS",
      "offer_id": 10002,
      "parse_value_with_expression": null,
      "value_formatter": null,
      "value_expression": null,
      "use_flow_when_pattern_matches": null,
      "record_token_filter_id": null,
      "token_value_ids": null,
      "request_a_response": true,
      "response_message": "Your quote is ready! Reply VIEW to receive the details.",
      "contact_field_assign_id": null,
      "contact_field_validate_id": null,
      "text_message_flow_id": null,
      "assert_acceptable_with_contact_field": null,
      "response_message_when_unacceptable": null,
      "record_token_additional_id": null,
      "attribution_token_value_ids": null,
      "outgoing_webhook_ids": [],
      "text_message_flows_count": 0,
      "process_response_with_sms_flow_type": null,
      "wait_for_response_seconds": 7200,
      "valid_responses_csv": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": [],
      "record_token_additional_data_count": 0,
      "record_token_additional_data": []
    },
    {
      "id": "a09e6bca-255b-4217-af73-cb9601c80217",
      "type": "TextMessageFlow",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T13:30:00.000Z",
      "updated_at": "2026-01-15T14:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": null,
      "routes_edit_path": "/text_message_flows/a09e6bca-255b-4217-af73-cb9601c80217/edit",
      "external_record_id": null,
      "name": "Example Text Message Flow (renamed)",
      "context_menu_name": "Example Text Message Flow (renamed)",
      "company_id": 10001,
      "user_id": null,
      "sortable_order": -5,
      "description": "Example Text Message Flow (renamed)",
      "offer_id": 10003,
      "parse_value_with_expression": null,
      "value_formatter": null,
      "value_expression": null,
      "use_flow_when_pattern_matches": null,
      "record_token_filter_id": null,
      "token_value_ids": null,
      "request_a_response": true,
      "response_message": "Your quote is ready! Reply VIEW to receive the details.",
      "contact_field_assign_id": null,
      "contact_field_validate_id": null,
      "text_message_flow_id": null,
      "assert_acceptable_with_contact_field": null,
      "response_message_when_unacceptable": null,
      "record_token_additional_id": null,
      "attribution_token_value_ids": null,
      "outgoing_webhook_ids": [],
      "text_message_flows_count": 0,
      "process_response_with_sms_flow_type": null,
      "wait_for_response_seconds": 7200,
      "valid_responses_csv": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": [],
      "record_token_additional_data_count": 0,
      "record_token_additional_data": []
    }
  ],
  "metadata": {
    "root": "text_message_flows",
    "page": 1,
    "total_pages": 3,
    "per_page": 2,
    "total_count": 6,
    "next_cursor": 10004
  }
}

GET /text_message_flows/new

Authorization Required

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

Build SMS Flow with defaults.

Returns an SMS Flow built with default attributes for previewing available fields. It is not saved.

Params

Param name	Description
description Optional	Description Must be a String
offer_id Optional	Offer Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
parse_value_with_expression Optional	Parse Value With Expression Must be a boolean value: 1, true, yes, on, 0, false, no, off
value_formatter Optional	Value Formatter Must be a String
value_expression Optional	Value Expression Must be a String
use_flow_when_pattern_matches Optional	Use Flow When Pattern Matches Must be a String
record_token_filter_id Optional	Record Token Filter Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional	Token Value Ids Must be a decimal number.
request_a_response Optional	Request A Response Must be a boolean value: 1, true, yes, on, 0, false, no, off
response_message Optional Blank value allowed	The outgoing SMS message sent back to the consumer when this flow matches the incoming message. Must be a String
assert_acceptable_with_contact_field Optional	Assert Acceptable With Contact Field Must be a boolean value: 1, true, yes, on, 0, false, no, off
response_message_when_unacceptable Optional	Response Message When Unacceptable Must be a String
attribution_token_value_ids Optional	Attribution Token Value Ids Must be a decimal number.
contact_field_assign_id Optional Blank value allowed	The Contact Field the consumer’s reply is saved to on the lead. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
contact_field_validate_id Optional Blank value allowed	The Contact Field checked against the accepted responses when `assert_acceptable_with_contact_field` is true. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
process_response_with_sms_flow_type Optional Blank value allowed	How the consumer’s reply is passed on for further processing after this flow matches. One of `nested_text_message_flows` (try the nested SMS Flows below this one) or `parent_text_message_flows` (pass it to this flow’s parent Offer or SMS Flow). Must be a String
valid_responses_csv Optional Blank value allowed	A comma-separated list of the responses accepted as valid when `assert_acceptable_with_contact_field` is true. Must be a String
wait_for_response_seconds Optional Blank value allowed	How many seconds Trackdrive waits for the consumer’s reply before giving up on this flow. Must be a decimal number.
text_message_flow_id Optional Blank value allowed	The parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows. Must be a valid foreign key reference to an SMS AI Flow. Refer to: /api/docs/1.0/text_message_flows
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 'https://[your-subdomain].trackdrive.com/api/v1/text_message_flows/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "text_message_flow": {
    "id": null,
    "type": "TextMessageFlow",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "name": "",
    "context_menu_name": "",
    "company_id": 10001,
    "user_id": null,
    "sortable_order": null,
    "description": null,
    "offer_id": null,
    "parse_value_with_expression": null,
    "value_formatter": null,
    "value_expression": null,
    "use_flow_when_pattern_matches": null,
    "record_token_filter_id": null,
    "token_value_ids": null,
    "request_a_response": null,
    "response_message": null,
    "contact_field_assign_id": null,
    "contact_field_validate_id": null,
    "text_message_flow_id": null,
    "assert_acceptable_with_contact_field": null,
    "response_message_when_unacceptable": null,
    "record_token_additional_id": null,
    "attribution_token_value_ids": null,
    "outgoing_webhook_ids": [],
    "text_message_flows_count": 0,
    "process_response_with_sms_flow_type": null,
    "wait_for_response_seconds": 300,
    "valid_responses_csv": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_data_count": 0,
    "record_token_additional_data": []
  },
  "metadata": {
    "root": "text_message_flow"
  }
}

POST /text_message_flows

Authorization Required

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

Create SMS Flow.

Creates an SMS Flow that matches inbound text messages against a pattern, tied to an offer, and optionally requests and validates a reply from the recipient.

Params

Param name	Description
description Optional	Description Must be a String
offer_id Optional	Offer Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
parse_value_with_expression Optional	Parse Value With Expression Must be a boolean value: 1, true, yes, on, 0, false, no, off
value_formatter Optional	Value Formatter Must be a String
value_expression Optional	Value Expression Must be a String
use_flow_when_pattern_matches Optional	Use Flow When Pattern Matches Must be a String
record_token_filter_id Optional	Record Token Filter Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional	Token Value Ids Must be a decimal number.
request_a_response Optional	Request A Response Must be a boolean value: 1, true, yes, on, 0, false, no, off
response_message Optional Blank value allowed	The outgoing SMS message sent back to the consumer when this flow matches the incoming message. Must be a String
assert_acceptable_with_contact_field Optional	Assert Acceptable With Contact Field Must be a boolean value: 1, true, yes, on, 0, false, no, off
response_message_when_unacceptable Optional	Response Message When Unacceptable Must be a String
attribution_token_value_ids Optional	Attribution Token Value Ids Must be a decimal number.
contact_field_assign_id Optional Blank value allowed	The Contact Field the consumer’s reply is saved to on the lead. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
contact_field_validate_id Optional Blank value allowed	The Contact Field checked against the accepted responses when `assert_acceptable_with_contact_field` is true. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
process_response_with_sms_flow_type Optional Blank value allowed	How the consumer’s reply is passed on for further processing after this flow matches. One of `nested_text_message_flows` (try the nested SMS Flows below this one) or `parent_text_message_flows` (pass it to this flow’s parent Offer or SMS Flow). Must be a String
valid_responses_csv Optional Blank value allowed	A comma-separated list of the responses accepted as valid when `assert_acceptable_with_contact_field` is true. Must be a String
wait_for_response_seconds Optional Blank value allowed	How many seconds Trackdrive waits for the consumer’s reply before giving up on this flow. Must be a decimal number.
text_message_flow_id Optional Blank value allowed	The parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows. Must be a valid foreign key reference to an SMS AI Flow. Refer to: /api/docs/1.0/text_message_flows
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/text_message_flows/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "offer_id": 10001,
  "description": "Example Text Message Flow",
  "request_a_response": true
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "text_message_flow": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "TextMessageFlow",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "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": null,
    "routes_edit_path": "/text_message_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "Example Text Message Flow",
    "context_menu_name": "Example Text Message Flow",
    "company_id": 10002,
    "user_id": null,
    "sortable_order": -1,
    "description": "Example Text Message Flow",
    "offer_id": 10001,
    "parse_value_with_expression": null,
    "value_formatter": null,
    "value_expression": null,
    "use_flow_when_pattern_matches": null,
    "record_token_filter_id": null,
    "token_value_ids": null,
    "request_a_response": true,
    "response_message": null,
    "contact_field_assign_id": null,
    "contact_field_validate_id": null,
    "text_message_flow_id": null,
    "assert_acceptable_with_contact_field": null,
    "response_message_when_unacceptable": null,
    "record_token_additional_id": null,
    "attribution_token_value_ids": null,
    "outgoing_webhook_ids": [],
    "text_message_flows_count": 0,
    "process_response_with_sms_flow_type": null,
    "wait_for_response_seconds": 300,
    "valid_responses_csv": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_data_count": 0,
    "record_token_additional_data": []
  },
  "metadata": {
    "root": "text_message_flow"
  }
}

GET /text_message_flows/:id

Authorization Required

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

Get SMS Flow by id.

Returns a single SMS Flow by id, including its matching pattern and response configuration.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/text_message_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "text_message_flow": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "TextMessageFlow",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "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": null,
    "routes_edit_path": "/text_message_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "Quote Request SMS",
    "context_menu_name": "Quote Request SMS",
    "company_id": 10001,
    "user_id": null,
    "sortable_order": -5,
    "description": "Quote Request SMS",
    "offer_id": 10002,
    "parse_value_with_expression": null,
    "value_formatter": null,
    "value_expression": null,
    "use_flow_when_pattern_matches": null,
    "record_token_filter_id": null,
    "token_value_ids": null,
    "request_a_response": true,
    "response_message": "Your quote is ready! Reply VIEW to receive the details.",
    "contact_field_assign_id": null,
    "contact_field_validate_id": null,
    "text_message_flow_id": null,
    "assert_acceptable_with_contact_field": null,
    "response_message_when_unacceptable": null,
    "record_token_additional_id": null,
    "attribution_token_value_ids": null,
    "outgoing_webhook_ids": [],
    "text_message_flows_count": 0,
    "process_response_with_sms_flow_type": null,
    "wait_for_response_seconds": 7200,
    "valid_responses_csv": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_data_count": 0,
    "record_token_additional_data": []
  },
  "metadata": {
    "root": "text_message_flow"
  }
}

PUT /text_message_flows/:id

Authorization Required

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

Update SMS Flow by id.

Updates an SMS Flow's matching pattern, offer, token values, or auto-response behavior.

Params

Param name	Description
description Optional	Description Must be a String
offer_id Optional	Offer Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
parse_value_with_expression Optional	Parse Value With Expression Must be a boolean value: 1, true, yes, on, 0, false, no, off
value_formatter Optional	Value Formatter Must be a String
value_expression Optional	Value Expression Must be a String
use_flow_when_pattern_matches Optional	Use Flow When Pattern Matches Must be a String
record_token_filter_id Optional	Record Token Filter Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional	Token Value Ids Must be a decimal number.
request_a_response Optional	Request A Response Must be a boolean value: 1, true, yes, on, 0, false, no, off
response_message Optional Blank value allowed	The outgoing SMS message sent back to the consumer when this flow matches the incoming message. Must be a String
assert_acceptable_with_contact_field Optional	Assert Acceptable With Contact Field Must be a boolean value: 1, true, yes, on, 0, false, no, off
response_message_when_unacceptable Optional	Response Message When Unacceptable Must be a String
attribution_token_value_ids Optional	Attribution Token Value Ids Must be a decimal number.
contact_field_assign_id Optional Blank value allowed	The Contact Field the consumer’s reply is saved to on the lead. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
contact_field_validate_id Optional Blank value allowed	The Contact Field checked against the accepted responses when `assert_acceptable_with_contact_field` is true. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
process_response_with_sms_flow_type Optional Blank value allowed	How the consumer’s reply is passed on for further processing after this flow matches. One of `nested_text_message_flows` (try the nested SMS Flows below this one) or `parent_text_message_flows` (pass it to this flow’s parent Offer or SMS Flow). Must be a String
valid_responses_csv Optional Blank value allowed	A comma-separated list of the responses accepted as valid when `assert_acceptable_with_contact_field` is true. Must be a String
wait_for_response_seconds Optional Blank value allowed	How many seconds Trackdrive waits for the consumer’s reply before giving up on this flow. Must be a decimal number.
text_message_flow_id Optional Blank value allowed	The parent SMS Flow this flow is nested under, tried when the parent’s reply is passed to its nested flows. Must be a valid foreign key reference to an SMS AI Flow. Refer to: /api/docs/1.0/text_message_flows
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 PUT 'https://[your-subdomain].trackdrive.com/api/v1/text_message_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Example Text Message Flow (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "text_message_flow": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "TextMessageFlow",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "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": null,
    "routes_edit_path": "/text_message_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "Example Text Message Flow (renamed)",
    "context_menu_name": "Example Text Message Flow (renamed)",
    "company_id": 10001,
    "user_id": null,
    "sortable_order": -2,
    "description": "Example Text Message Flow (renamed)",
    "offer_id": 10002,
    "parse_value_with_expression": null,
    "value_formatter": null,
    "value_expression": null,
    "use_flow_when_pattern_matches": null,
    "record_token_filter_id": null,
    "token_value_ids": null,
    "request_a_response": true,
    "response_message": null,
    "contact_field_assign_id": null,
    "contact_field_validate_id": null,
    "text_message_flow_id": null,
    "assert_acceptable_with_contact_field": null,
    "response_message_when_unacceptable": null,
    "record_token_additional_id": null,
    "attribution_token_value_ids": null,
    "outgoing_webhook_ids": [],
    "text_message_flows_count": 0,
    "process_response_with_sms_flow_type": null,
    "wait_for_response_seconds": 300,
    "valid_responses_csv": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_data_count": 0,
    "record_token_additional_data": []
  },
  "metadata": {
    "root": "text_message_flow"
  }
}

DELETE /text_message_flows/:id

Authorization Required

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

Destroy SMS Flow by id.

Permanently deletes an SMS Flow, so it no longer matches incoming text messages.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/text_message_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "text_message_flow": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "TextMessageFlow",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": "/text_message_flows/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "Example Text Message Flow",
    "context_menu_name": "Example Text Message Flow",
    "company_id": 10001,
    "user_id": null,
    "sortable_order": -2,
    "description": "Example Text Message Flow",
    "offer_id": 10002,
    "parse_value_with_expression": null,
    "value_formatter": null,
    "value_expression": null,
    "use_flow_when_pattern_matches": null,
    "record_token_filter_id": null,
    "token_value_ids": null,
    "request_a_response": true,
    "response_message": null,
    "contact_field_assign_id": null,
    "contact_field_validate_id": null,
    "text_message_flow_id": null,
    "assert_acceptable_with_contact_field": null,
    "response_message_when_unacceptable": null,
    "record_token_additional_id": null,
    "attribution_token_value_ids": null,
    "outgoing_webhook_ids": [],
    "text_message_flows_count": 0,
    "process_response_with_sms_flow_type": null,
    "wait_for_response_seconds": 300,
    "valid_responses_csv": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_data_count": 0,
    "record_token_additional_data": []
  },
  "metadata": {
    "root": "text_message_flow"
  }
}

Params

Must be any combination of:

Params

Params

Params