API documentation

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