API documentation

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"
  }
}