API documentation

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