API documentation

GET /schedule_distributions

Authorization Required

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

List Distribution records.

Lists the Lead Distribution rules that move leads from one schedule to a target schedule whenever they match a filter group. When filtering by ids, results are returned in their configured sortable order.

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 schedule_id target_schedule_id description sortable_order record_token_filter_id record_token_filter_data_count record_token_filter_data 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/schedule_distributions/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "schedule_distributions": [
    {
      "id": 10001,
      "type": "ScheduleDistribution",
      "uuid": null,
      "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": "/schedule_distributions/10001",
      "routes_edit_path": "/schedule_distributions/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "schedule_id": 10003,
      "target_schedule_id": 10004,
      "description": "Split Traffic To Backup Schedule",
      "sortable_order": null,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": 10005,
      "type": "ScheduleDistribution",
      "uuid": null,
      "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": "/schedule_distributions/10005",
      "routes_edit_path": "/schedule_distributions/10005/edit",
      "external_record_id": null,
      "company_id": 10002,
      "schedule_id": 10006,
      "target_schedule_id": 10007,
      "description": "Overflow To Secondary Schedule",
      "sortable_order": null,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "schedule_distributions",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 2,
    "next_cursor": 10008
  }
}

GET /schedule_distributions/new

Authorization Required

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

Build Distribution with defaults.

Returns a blank Lead Distribution record populated with default attribute values, without saving it.

Params

Param name	Description
schedule_id Optional Blank value allowed	Schedule Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
target_schedule_id Optional Blank value allowed	Target Schedule Must be a decimal number.
filter_group_id Optional Blank value allowed	The lead will be moved to the target schedule when it matches this Filter Group. Must be a valid foreign key reference to an Filter Group. Refer to: /api/docs/1.0/filter_groups
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
token_value_ids Optional Blank value allowed	Leads matching these tokens will be moved to the target schedule. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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"`

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_distribution": {
    "id": null,
    "type": "ScheduleDistribution",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/schedule_distributions/new",
    "routes_edit_path": "/schedule_distributions/new",
    "external_record_id": null,
    "company_id": 10001,
    "schedule_id": null,
    "target_schedule_id": null,
    "description": null,
    "sortable_order": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_distribution"
  }
}

POST /schedule_distributions

Authorization Required

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

Create Distribution.

Creates a Lead Distribution rule that reassigns leads on the given schedule to target_schedule whenever they match filter_group_id. If no description is provided, one is generated from the target schedule's name.

Params

Param name	Description
schedule_id Optional Blank value allowed	Schedule Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
target_schedule_id Optional Blank value allowed	Target Schedule Must be a decimal number.
filter_group_id Optional Blank value allowed	The lead will be moved to the target schedule when it matches this Filter Group. Must be a valid foreign key reference to an Filter Group. Refer to: /api/docs/1.0/filter_groups
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
token_value_ids Optional Blank value allowed	Leads matching these tokens will be moved to the target schedule. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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_id Optional Blank value allowed	Attach an existing Record Token Filter instead of building one from token_value_ids or record_token_filter_list. Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/schedule_distributions/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "schedule_id": 10001,
  "target_schedule_id": 10002,
  "description": "Example schedule distribution created by the API docs generator."
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "schedule_distribution": {
    "id": 10003,
    "type": "ScheduleDistribution",
    "uuid": null,
    "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": "/schedule_distributions/10003",
    "routes_edit_path": "/schedule_distributions/10003/edit",
    "external_record_id": null,
    "company_id": 10004,
    "schedule_id": 10001,
    "target_schedule_id": 10002,
    "description": "Example schedule distribution created by the API docs generator.",
    "sortable_order": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_distribution"
  }
}

GET /schedule_distributions/:id

Authorization Required

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

Get Distribution by id.

Fetches a single Lead Distribution rule by id.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_distribution": {
    "id": 10001,
    "type": "ScheduleDistribution",
    "uuid": null,
    "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": "/schedule_distributions/10001",
    "routes_edit_path": "/schedule_distributions/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "schedule_id": 10003,
    "target_schedule_id": 10004,
    "description": "Split Traffic To Backup Schedule",
    "sortable_order": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_distribution"
  }
}

PUT /schedule_distributions/:id

Authorization Required

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

Update Distribution by id.

Updates a Lead Distribution rule's target schedule or description. The source schedule and filter group are set at creation and are not part of this endpoint's editable fields.

Params

Param name	Description
schedule_id Optional Blank value allowed	Schedule Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
target_schedule_id Optional Blank value allowed	Target Schedule Must be a decimal number.
filter_group_id Optional Blank value allowed	The lead will be moved to the target schedule when it matches this Filter Group. Must be a valid foreign key reference to an Filter Group. Refer to: /api/docs/1.0/filter_groups
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
token_value_ids Optional Blank value allowed	Leads matching these tokens will be moved to the target schedule. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
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"`

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/schedule_distributions/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Example schedule distribution (renamed)."
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_distribution": {
    "id": 10001,
    "type": "ScheduleDistribution",
    "uuid": null,
    "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": "/schedule_distributions/10001",
    "routes_edit_path": "/schedule_distributions/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "schedule_id": 10003,
    "target_schedule_id": 10004,
    "description": "Example schedule distribution (renamed).",
    "sortable_order": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_distribution"
  }
}

DELETE /schedule_distributions/:id

Authorization Required

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

Destroy Distribution by id.

Deletes a Lead Distribution rule by id. Leads on the source schedule will no longer be moved to the target schedule for that filter match.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/schedule_distributions/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "schedule_distribution": {
    "id": 10001,
    "type": "ScheduleDistribution",
    "uuid": null,
    "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": "/schedule_distributions/10001",
    "routes_edit_path": "/schedule_distributions/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "schedule_id": 10003,
    "target_schedule_id": 10004,
    "description": "Example schedule distribution created by the API docs generator.",
    "sortable_order": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "schedule_distribution"
  }
}

Params

Must be any combination of:

Params

Params

Params