API documentation

GET /api/v1/lead_wait_rules
List Wait Rule 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 a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a 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 company_id name wait_seconds description filter_call_disposition_ids filter_call_disposition_two_ids record_token_filter_two_id tier record_token_filter_id record_token_filter_data_count record_token_filter_data record_token_filter_two_data_count record_token_filter_two_data lead_wait_rule_group_ids Validations: 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: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/lead_wait_rules/new
Build Wait Rule with defaults.

Params

Param name	Description Validations
name Optional Blank Value Allowed	Name Validations: Must be a String
wait_seconds Optional Blank Value Allowed	Wait Seconds Validations: Must be a decimal number.
description Optional Blank Value Allowed	Description Validations: Must be a String
filter_call_disposition_ids Optional Blank Value Allowed	Call Dispositions Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions
filter_call_disposition_two_ids Optional Blank Value Allowed	Call Dispositions Two Calls Ago Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions
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.
record_token_filter_two_id Optional Blank Value Allowed	Record Token Filter Two Validations: Must be a String
token_value_two_ids Optional Blank Value Allowed	Token Value Two Ids Validations: Must be a decimal number.

POST /api/v1/lead_wait_rules
Create Wait Rule.

Params

Param name	Description Validations
name Optional Blank Value Allowed	Name Validations: Must be a String
wait_seconds Optional Blank Value Allowed	Wait Seconds Validations: Must be a decimal number.
description Optional Blank Value Allowed	Description Validations: Must be a String
filter_call_disposition_ids Optional Blank Value Allowed	Call Dispositions Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions
filter_call_disposition_two_ids Optional Blank Value Allowed	Call Dispositions Two Calls Ago Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions
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.
record_token_filter_two_id Optional Blank Value Allowed	Record Token Filter Two Validations: Must be a String
token_value_two_ids Optional Blank Value Allowed	Token Value Two Ids Validations: Must be a decimal number.

GET /api/v1/lead_wait_rules/:id
Get Wait Rule by id.

PUT /api/v1/lead_wait_rules/:id
Update Wait Rule by id.

Params

Param name	Description Validations
name Optional Blank Value Allowed	Name Validations: Must be a String
wait_seconds Optional Blank Value Allowed	Wait Seconds Validations: Must be a decimal number.
description Optional Blank Value Allowed	Description Validations: Must be a String
filter_call_disposition_ids Optional Blank Value Allowed	Call Dispositions Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions
filter_call_disposition_two_ids Optional Blank Value Allowed	Call Dispositions Two Calls Ago Validations: Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Disposition. Refer to: /api/docs/1.0/call_dispositions
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.
record_token_filter_two_id Optional Blank Value Allowed	Record Token Filter Two Validations: Must be a String
token_value_two_ids Optional Blank Value Allowed	Token Value Two Ids Validations: Must be a decimal number.

DELETE /api/v1/lead_wait_rules/:id
Destroy Wait Rule by id.