GET /api/v1/text_message_flows
List SMS Flow records.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.com/profile/edit

  • Must be String

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 String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

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


GET /api/v1/text_message_flows/new
Build SMS Flow with defaults.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.com/profile/edit

  • Must be String

description
Optional Blank Value Allowed

Description

  • Must be String

offer_id
Optional Blank Value Allowed

Offer

parse_value_with_expression
Optional Blank Value Allowed

Parse Value With Expression

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

value_formatter
Optional Blank Value Allowed

Value Formatter

  • Must be String

value_expression
Optional Blank Value Allowed

Value Expression

  • Must be String

use_flow_when_pattern_matches
Optional Blank Value Allowed

Use Flow When Pattern Matches

  • Must be String

record_token_filter_id
Optional Blank Value Allowed

Record Token Filter

token_value_ids
Optional Blank Value Allowed

Token Value Ids

  • Must be a decimal number.

request_a_response
Optional Blank Value Allowed

Request A Response

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

key
Optional Blank Value Allowed

translation missing: en.api.text_message_flows.key

  • Must be String

assert_acceptable_with_contact_field
Optional Blank Value Allowed

Assert Acceptable With Contact Field

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

response_message_when_unacceptable
Optional Blank Value Allowed

Response Message When Unacceptable

  • Must be String

attribution_token_value_ids
Optional Blank Value Allowed

Attribution Token Value Ids

  • Must be a decimal number.


Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.com/profile/edit

  • Must be String

description
Optional Blank Value Allowed

Description

  • Must be String

offer_id
Optional Blank Value Allowed

Offer

parse_value_with_expression
Optional Blank Value Allowed

Parse Value With Expression

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

value_formatter
Optional Blank Value Allowed

Value Formatter

  • Must be String

value_expression
Optional Blank Value Allowed

Value Expression

  • Must be String

use_flow_when_pattern_matches
Optional Blank Value Allowed

Use Flow When Pattern Matches

  • Must be String

record_token_filter_id
Optional Blank Value Allowed

Record Token Filter

token_value_ids
Optional Blank Value Allowed

Token Value Ids

  • Must be a decimal number.

request_a_response
Optional Blank Value Allowed

Request A Response

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

key
Optional Blank Value Allowed

translation missing: en.api.text_message_flows.key

  • Must be String

assert_acceptable_with_contact_field
Optional Blank Value Allowed

Assert Acceptable With Contact Field

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

response_message_when_unacceptable
Optional Blank Value Allowed

Response Message When Unacceptable

  • Must be String

attribution_token_value_ids
Optional Blank Value Allowed

Attribution Token Value Ids

  • Must be a decimal number.


Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.com/profile/edit

  • Must be String


Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.com/profile/edit

  • Must be String

description
Optional Blank Value Allowed

Description

  • Must be String

offer_id
Optional Blank Value Allowed

Offer

parse_value_with_expression
Optional Blank Value Allowed

Parse Value With Expression

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

value_formatter
Optional Blank Value Allowed

Value Formatter

  • Must be String

value_expression
Optional Blank Value Allowed

Value Expression

  • Must be String

use_flow_when_pattern_matches
Optional Blank Value Allowed

Use Flow When Pattern Matches

  • Must be String

record_token_filter_id
Optional Blank Value Allowed

Record Token Filter

token_value_ids
Optional Blank Value Allowed

Token Value Ids

  • Must be a decimal number.

request_a_response
Optional Blank Value Allowed

Request A Response

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

key
Optional Blank Value Allowed

translation missing: en.api.text_message_flows.key

  • Must be String

assert_acceptable_with_contact_field
Optional Blank Value Allowed

Assert Acceptable With Contact Field

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

response_message_when_unacceptable
Optional Blank Value Allowed

Response Message When Unacceptable

  • Must be String

attribution_token_value_ids
Optional Blank Value Allowed

Attribution Token Value Ids

  • Must be a decimal number.


Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.com/profile/edit

  • Must be String