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
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
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.
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