API documentation

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

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be String
fulltext Optional	Search for any record that matches this text Validations: Must be String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: 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 Validations: 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: {}}` Validations: 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 Validations
description Optional Blank Value Allowed	Description Validations: Must be String
offer_id Optional Blank Value Allowed	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
parse_value_with_expression Optional Blank Value Allowed	Parse Value With Expression Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off
value_formatter Optional Blank Value Allowed	Value Formatter Validations: Must be String
value_expression Optional Blank Value Allowed	Value Expression Validations: Must be String
use_flow_when_pattern_matches Optional Blank Value Allowed	Use Flow When Pattern Matches Validations: Must be String
record_token_filter_id Optional Blank Value Allowed	Record Token Filter Validations: Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional Blank Value Allowed	Token Value Ids Validations: Must be a decimal number.
request_a_response Optional Blank Value Allowed	Request A Response Validations: 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 Validations: Must be String
assert_acceptable_with_contact_field Optional Blank Value Allowed	Assert Acceptable With Contact Field Validations: 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 Validations: Must be String
attribution_token_value_ids Optional Blank Value Allowed	Attribution Token Value Ids Validations: Must be a decimal number.

POST /api/v1/text_message_flows
Create SMS Flow.

Params

Param name	Description Validations
description Optional Blank Value Allowed	Description Validations: Must be String
offer_id Optional Blank Value Allowed	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
parse_value_with_expression Optional Blank Value Allowed	Parse Value With Expression Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off
value_formatter Optional Blank Value Allowed	Value Formatter Validations: Must be String
value_expression Optional Blank Value Allowed	Value Expression Validations: Must be String
use_flow_when_pattern_matches Optional Blank Value Allowed	Use Flow When Pattern Matches Validations: Must be String
record_token_filter_id Optional Blank Value Allowed	Record Token Filter Validations: Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional Blank Value Allowed	Token Value Ids Validations: Must be a decimal number.
request_a_response Optional Blank Value Allowed	Request A Response Validations: 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 Validations: Must be String
assert_acceptable_with_contact_field Optional Blank Value Allowed	Assert Acceptable With Contact Field Validations: 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 Validations: Must be String
attribution_token_value_ids Optional Blank Value Allowed	Attribution Token Value Ids Validations: Must be a decimal number.

GET /api/v1/text_message_flows/:id
Get SMS Flow by id.

PUT /api/v1/text_message_flows/:id
Update SMS Flow by id.

Params

Param name	Description Validations
description Optional Blank Value Allowed	Description Validations: Must be String
offer_id Optional Blank Value Allowed	Offer Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
parse_value_with_expression Optional Blank Value Allowed	Parse Value With Expression Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off
value_formatter Optional Blank Value Allowed	Value Formatter Validations: Must be String
value_expression Optional Blank Value Allowed	Value Expression Validations: Must be String
use_flow_when_pattern_matches Optional Blank Value Allowed	Use Flow When Pattern Matches Validations: Must be String
record_token_filter_id Optional Blank Value Allowed	Record Token Filter Validations: Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional Blank Value Allowed	Token Value Ids Validations: Must be a decimal number.
request_a_response Optional Blank Value Allowed	Request A Response Validations: 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 Validations: Must be String
assert_acceptable_with_contact_field Optional Blank Value Allowed	Assert Acceptable With Contact Field Validations: 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 Validations: Must be String
attribution_token_value_ids Optional Blank Value Allowed	Attribution Token Value Ids Validations: Must be a decimal number.

DELETE /api/v1/text_message_flows/:id
Destroy SMS Flow by id.