API documentation

GET /lead_wait_rules

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules

List Wait Rule records.

Lists Wait Rules, which pause a lead within a schedule for a configured number of seconds, optionally only when it matches prior call disposition or token filter criteria.

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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "lead_wait_rules": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "LeadWaitRule",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "company_id": 10001,
      "name": "24 Hour Wait",
      "wait_seconds": 86400,
      "description": "Next-day retry for aged leads",
      "filter_call_disposition_ids": null,
      "filter_call_disposition_two_ids": null,
      "record_token_filter_two_id": null,
      "tier": 6,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": [],
      "record_token_filter_two_data_count": 0,
      "record_token_filter_two_data": [],
      "lead_wait_rule_group_ids": null
    },
    {
      "id": "a09e6bca-255b-4217-af73-cb9601c80217",
      "type": "LeadWaitRule",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/lead_wait_rules/a09e6bca-255b-4217-af73-cb9601c80217",
      "routes_edit_path": "/lead_wait_rules/a09e6bca-255b-4217-af73-cb9601c80217/edit",
      "external_record_id": null,
      "company_id": 10001,
      "name": "4 Hour Wait",
      "wait_seconds": 14400,
      "description": "Long wait before re-engagement",
      "filter_call_disposition_ids": null,
      "filter_call_disposition_two_ids": null,
      "record_token_filter_two_id": null,
      "tier": 5,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": [],
      "record_token_filter_two_data_count": 0,
      "record_token_filter_two_data": [],
      "lead_wait_rule_group_ids": null
    }
  ],
  "metadata": {
    "root": "lead_wait_rules",
    "page": 1,
    "total_pages": 3,
    "per_page": 2,
    "total_count": 6,
    "next_cursor": 10002
  }
}

GET /lead_wait_rules/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/new

Build Wait Rule with defaults.

Builds a Wait Rule with default attributes without saving it.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
wait_seconds Optional Blank value allowed	Wait Seconds Must be a decimal number.
description Optional Blank value allowed	Description Must be a String
filter_call_disposition_ids Optional Blank value allowed	Call Dispositions 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 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 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 Must be a decimal number.
record_token_filter_two_id Optional Blank value allowed	Record Token Filter Two Must be a String
token_value_two_ids Optional Blank value allowed	Token Value Two Ids Must be a decimal number.
tier Optional Blank value allowed	The order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first. Must be a decimal number.
lead_wait_rule_group_ids Optional Blank value allowed	Assign this rule to these Wait Rule Groups. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Lead Wait Rule Group. Refer to: /api/docs/1.0/lead_wait_rule_groups
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_filter_two_list Optional Blank value allowed	Assign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list. Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "lead_wait_rule": {
    "id": null,
    "type": "LeadWaitRule",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/lead_wait_rules/new",
    "routes_edit_path": "/lead_wait_rules/new",
    "external_record_id": null,
    "company_id": 10001,
    "name": null,
    "wait_seconds": null,
    "description": null,
    "filter_call_disposition_ids": null,
    "filter_call_disposition_two_ids": null,
    "record_token_filter_two_id": null,
    "tier": 7,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_filter_two_data_count": 0,
    "record_token_filter_two_data": [],
    "lead_wait_rule_group_ids": []
  },
  "metadata": {
    "root": "lead_wait_rule"
  }
}

POST /lead_wait_rules

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules

Create Wait Rule.

Creates a Wait Rule specifying wait_seconds and, optionally, the call dispositions or token filters that must match for the wait to apply.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
wait_seconds Optional Blank value allowed	Wait Seconds Must be a decimal number.
description Optional Blank value allowed	Description Must be a String
filter_call_disposition_ids Optional Blank value allowed	Call Dispositions 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 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 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 Must be a decimal number.
record_token_filter_two_id Optional Blank value allowed	Record Token Filter Two Must be a String
token_value_two_ids Optional Blank value allowed	Token Value Two Ids Must be a decimal number.
tier Optional Blank value allowed	The order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first. Must be a decimal number.
lead_wait_rule_group_ids Optional Blank value allowed	Assign this rule to these Wait Rule Groups. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Lead Wait Rule Group. Refer to: /api/docs/1.0/lead_wait_rule_groups
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_filter_two_list Optional Blank value allowed	Assign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list. Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Lead Wait Rule",
  "description": "Example wait cadence for a lead retry",
  "wait_seconds": 900,
  "tier": 99
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "lead_wait_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "LeadWaitRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "name": "Example Lead Wait Rule",
    "wait_seconds": 900,
    "description": "Example wait cadence for a lead retry",
    "filter_call_disposition_ids": null,
    "filter_call_disposition_two_ids": null,
    "record_token_filter_two_id": null,
    "tier": 99,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_filter_two_data_count": 0,
    "record_token_filter_two_data": [],
    "lead_wait_rule_group_ids": []
  },
  "metadata": {
    "root": "lead_wait_rule"
  }
}

GET /lead_wait_rules/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/:id

Get Wait Rule by id.

Gets a Wait Rule's details by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "lead_wait_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "LeadWaitRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "name": "24 Hour Wait",
    "wait_seconds": 86400,
    "description": "Next-day retry for aged leads",
    "filter_call_disposition_ids": null,
    "filter_call_disposition_two_ids": null,
    "record_token_filter_two_id": null,
    "tier": 6,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_filter_two_data_count": 0,
    "record_token_filter_two_data": [],
    "lead_wait_rule_group_ids": [
      "a09e6bca-255b-4217-af73-cb9601c80217",
      "49cca320-d2dd-4768-a730-8fc3e0a664e7"
    ]
  },
  "metadata": {
    "root": "lead_wait_rule"
  }
}

PUT /lead_wait_rules/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/:id

Update Wait Rule by id.

Updates a Wait Rule's wait duration, description, or matching criteria.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
wait_seconds Optional Blank value allowed	Wait Seconds Must be a decimal number.
description Optional Blank value allowed	Description Must be a String
filter_call_disposition_ids Optional Blank value allowed	Call Dispositions 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 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 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 Must be a decimal number.
record_token_filter_two_id Optional Blank value allowed	Record Token Filter Two Must be a String
token_value_two_ids Optional Blank value allowed	Token Value Two Ids Must be a decimal number.
tier Optional Blank value allowed	The order this rule is checked in relative to the company’s other Wait Rules. Lower tiers are checked first. Must be a decimal number.
lead_wait_rule_group_ids Optional Blank value allowed	Assign this rule to these Wait Rule Groups. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Lead Wait Rule Group. Refer to: /api/docs/1.0/lead_wait_rule_groups
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_filter_two_list Optional Blank value allowed	Assign the alternate (two) filter by passing an array of key:value pairs, in the same format as record_token_filter_list. Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Lead Wait Rule (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "lead_wait_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "LeadWaitRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "name": "Example Lead Wait Rule (renamed)",
    "wait_seconds": 900,
    "description": "Example wait cadence for a lead retry",
    "filter_call_disposition_ids": null,
    "filter_call_disposition_two_ids": null,
    "record_token_filter_two_id": null,
    "tier": 99,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_filter_two_data_count": 0,
    "record_token_filter_two_data": [],
    "lead_wait_rule_group_ids": []
  },
  "metadata": {
    "root": "lead_wait_rule"
  }
}

DELETE /lead_wait_rules/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/:id

Destroy Wait Rule by id.

Deletes a Wait Rule by id.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "lead_wait_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "LeadWaitRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/lead_wait_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "name": "Example Lead Wait Rule",
    "wait_seconds": 900,
    "description": "Example wait cadence for a lead retry",
    "filter_call_disposition_ids": null,
    "filter_call_disposition_two_ids": null,
    "record_token_filter_two_id": null,
    "tier": 99,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_filter_two_data_count": 0,
    "record_token_filter_two_data": [],
    "lead_wait_rule_group_ids": []
  },
  "metadata": {
    "root": "lead_wait_rule"
  }
}

Params

Must be any combination of:

Params

Params

Params