Wait Rule Groups

A named collection of wait rules that a schedule matches against to calculate how long to pause a lead.

GET /lead_wait_rule_groups

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rule_groups

List Wait Rule Group records.

Lists Wait Rule Groups, which bundle Lead Wait Rules used to delay or stagger when a lead becomes available to buyers.

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.
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
  • description
  • lead_wait_rules_count

  • 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

GET /lead_wait_rule_groups/new

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rule_groups/new

Build Wait Rule Group with defaults.

Returns a blank Wait Rule Group populated with default attribute values, without saving it.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
lead_wait_rule_ids
Optional Blank value allowed

Lead Wait Rule Ids

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

POST /lead_wait_rule_groups

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rule_groups

Create Wait Rule Group.

Creates a Wait Rule Group, optionally attaching existing Lead Wait Rules to it via lead_wait_rule_ids.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
lead_wait_rule_ids
Optional Blank value allowed

Lead Wait Rule Ids

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

GET /lead_wait_rule_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rule_groups/:id

Get Wait Rule Group by id.

Fetches a single Wait Rule Group by id.

PUT /lead_wait_rule_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rule_groups/:id

Update Wait Rule Group by id.

Updates a Wait Rule Group's name, description, or the Lead Wait Rules attached to it.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
lead_wait_rule_ids
Optional Blank value allowed

Lead Wait Rule Ids

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

DELETE /lead_wait_rule_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rule_groups/:id

Destroy Wait Rule Group by id.

Deletes a Wait Rule Group by id.