Schedules

The lead distribution and dialing configuration that controls how leads flow through your account and get called.

GET /schedules

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/schedules

List Schedules.

Lists the schedules in your account. Supports full-text search, filtering by a creation date range, sorting, and pagination, and results can be returned as JSON or CSV. Each schedule includes its actions, end-of-schedule actions, and triggers.

Supported Formats

json, csv

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    scheduleDefault response format.
    schedule_gridModern response format that returns various foreign keys for use with other API endpoints.
page
Optional

Return the next page of results.

  • 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
order
Optional

Sort results by this field.

  • Must be one of: sortable_order, offer_id, name, paused, offer_id, leads_api_key, time_zone, schedule_type, numbers_count, last_call_at, calls_count, instant_agent_dial_weight, created_at, updated_at, recent_calls_count, use_do_not_call, use_machine_detection, action_dial_skip_mobile, off_hook_enabled, real_time_priority, dial_caller_name, daylight_hours_open, daylight_hours_close, leads_sort_order_type, checked_leads_agent_dial_actions_at, checked_leads_no_match_actions_at.
order_dir
Optional

Sort results in ascending or descending order.

  • Must be one of: asc, desc.
fulltext
Optional

Search for any record that matches this text

  • Must be a String
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
  • offer_id
  • lead_token
  • leads_api_key
  • name
  • time_zone
  • max_leads_per_remote_ip_interval
  • max_leads_per_remote_ip
  • last_call_at
  • calls_count
  • recent_calls_count
  • action_sms_provider_configuration_id
  • action_sms_ring_pool_id
  • action_sms_number_id
  • action_sms_use_ring_pool
  • action_dial_use_ring_pool
  • during_daylight_hours
  • use_do_not_call
  • available_cc_percentage
  • calls_on_hold_limit
  • use_machine_detection
  • action_dial_skip_mobile
  • off_hook_enabled
  • skip_placing_calls_until_agent_count_exceeds
  • paused
  • paused_at
  • unpaused_at
  • paused_by_user_id
  • dial_caller_name
  • daylight_hours_open
  • daylight_hours_close
  • numbers_count
  • leads_sort_order_type
  • action_ids
  • end_of_schedule_action_ids
  • schedule_trigger_ids
  • record_token_filter_end_of_schedule_id
  • record_token_filter_end_of_schedule_data_count
  • record_token_filter_end_of_schedule_data
  • record_token_filter_scheduled_callback_id
  • record_token_filter_scheduled_callback_data_count
  • record_token_filter_scheduled_callback_data
  • machine_detection_record_token_filter_id
  • machine_detection_record_token_filter_data_count
  • machine_detection_record_token_filter_data
  • record_token_filter_id
  • record_token_filter_data_count
  • record_token_filter_data

  • Must be a String

GET /schedules/new

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/schedules/new

Build Schedule with defaults.

Builds an unsaved schedule populated with Trackdrive's default attribute values so you can preview the settings before calling create. Nothing is saved to your account.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    scheduleDefault response format.
    schedule_gridModern response format that returns various foreign keys for use with other API endpoints.

POST /schedules

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/schedules

Create Schedule.

Creates a new schedule in your account, used to configure lead distribution and dialing, from submitted attributes such as name, linked offer, description, and paused state.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    scheduleDefault response format.
    schedule_gridModern response format that returns various foreign keys for use with other API endpoints.
schedule_type
Optional Blank value allowed

The type of schedule to create, eg contact_caller or lead_distribution. Cannot be changed after creation.

  • Must be a String
name
Optional Blank value allowed

Name

  • Must be a String
offer_id
Optional Blank value allowed

Offer
description
Optional Blank value allowed

A human readable description of the record.

  • Must be a String
paused
Optional Blank value allowed

Paused

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
external_record_id
Optional Blank value allowed

Your own identifier for this schedule, used to correlate it with a record in an external system.

  • Must be a String
off_hook_enabled
Optional Blank value allowed

Turns on Instant Agent Mode, which sends calls to logged-in agents through dial_agents_number_id instead of a Ring Pool or Number.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
dial_agents_number_id
Optional Blank value allowed

The number agents call in to when off_hook_enabled is true.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
action_dial_with_type
Optional Blank value allowed

Whether outbound dialing from this schedule uses a single Number or a Ring Pool.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    numberDial leads using a single tracking number.
    ring_poolDial leads using a pool of tracking numbers.
dial_consumers_number_id
Optional Blank value allowed

The number used to dial leads when action_dial_with_type is number.
dial_caller_name
Optional Blank value allowed

The caller ID name shown to leads when this schedule places a call. Limited to 15 characters.

  • Must be a String
action_dial_skip_mobile
Optional Blank value allowed

Skip dialing lead phone numbers identified as mobile.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
enforce_tcpa_actions_today
Optional Blank value allowed

Only run TCPA-restricted actions when the current day still allows contacting the lead.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
skip_placing_calls_until_agent_count_exceeds
Optional Blank value allowed

Delay placing outbound calls until at least this many agents are logged into the offer.

  • Must be a decimal number.
buyer_is_available_with_qa_agents
Optional Blank value allowed

Treat buyers as available for IVR dialing while agents are in QA.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
instant_agent_dial_weight
Optional Blank value allowed

The relative weight given to this schedule when Instant Agent Mode distributes leads across multiple schedules.

  • Must be a decimal number.
distribute_calls_across_schedules
Optional Blank value allowed

Allow Instant Agent Mode to distribute calls for this schedule across other schedules on the same offer.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
leads_sort_order_type
Optional Blank value allowed

The order leads are dialed in during Instant Agent Mode, eg first_in_first_out or last_in_first_out.

  • Must be a String
real_time_priority
Optional Blank value allowed

The dial priority used when leads_sort_order_type is last_in_first_out.

  • Must be a decimal number.
allow_rtp_after_hours
Optional Blank value allowed

Allow real-time-priority leads to be dialed outside of business hours.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
intersperse_leads
Optional Blank value allowed

Mix in leads sorted by intersperse_sort_order_type alongside the normal dial order.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
intersperse_sort_order_type
Optional Blank value allowed

The sort order used for the interspersed leads when intersperse_leads is true.

  • Must be a String
intersperse_percent
Optional Blank value allowed

The percentage of dialed leads, between 5 and 95, drawn from the interspersed sort order.

  • Must be a decimal number.
available_cc_percentage
Optional Blank value allowed

The percentage of the offer’s concurrency cap this schedule may use for outbound calls. Leave blank for unlimited.

  • Must be a decimal number.
calls_on_hold_limit
Optional Blank value allowed

The maximum number of calls this schedule will hold at once.

  • Must be a decimal number.
callback_expiry_seconds
Optional Blank value allowed

How long, in seconds, a scheduled callback remains valid before it expires.

  • Must be a decimal number.
before_schedule_action_dial_next_action_seconds
Optional Blank value allowed

How long, in seconds, to wait before moving a lead to the next dial action.

  • Must be a decimal number.
use_for_scheduled_callbacks
Optional Blank value allowed

Allow leads on this schedule to be placed into scheduled callbacks.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
enabled_automatically_place_scheduled_callbacks
Optional Blank value allowed

Automatically place scheduled callbacks instead of requiring an agent to dial them manually.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
use_machine_detection
Optional Blank value allowed

Use answering machine detection on outbound calls from this schedule.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
action_sms_use_ring_pool
Optional Blank value allowed

Send SMS actions from a Ring Pool instead of a single number.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
action_sms_ring_pool_id
Optional Blank value allowed

The Ring Pool used to send SMS actions when action_sms_use_ring_pool is true.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
action_sms_number_id
Optional Blank value allowed

The number used to send SMS actions when action_sms_use_ring_pool is false.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
contact_caller_permission_required
Optional Blank value allowed

Require the lead’s permission before running certain schedule actions.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
contact_caller_permission_action_types
Optional Blank value allowed

The action types that require contact caller permission when contact_caller_permission_required is true.

  • Must be an array of strings. EG: ["abc123", "xzy023"]
require_traffic_source_id
Optional Blank value allowed

Reject leads submitted to this schedule without a traffic_source_id.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
lead_traffic_source_reject_duplicates
Optional Blank value allowed

Reject a lead when another lead with the same traffic source already exists on this schedule.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
enforce_contact_field_validations
Optional Blank value allowed

Validate submitted leads against this schedule’s contact field configuration.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
minimum_caller_number_length
Optional Blank value allowed

Reject leads whose phone number has fewer digits than this.

  • Must be a decimal number.
maximum_caller_number_length
Optional Blank value allowed

Reject leads whose phone number has more digits than this.

  • Must be a decimal number.
lead_duplicate_timeframe_scope
Optional Blank value allowed

Whether lead_duplicate_timeframe checks for duplicates within this schedule or across the whole company.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    schedule_idDedupe against leads on this schedule only.
    company_idDedupe against all leads in your account.
max_leads_per_remote_ip
Optional Blank value allowed

The maximum number of leads accepted from the same remote IP within max_leads_per_remote_ip_interval.

  • Must be a decimal number.
max_leads_per_remote_ip_interval
Optional Blank value allowed

The interval, in seconds, over which max_leads_per_remote_ip is enforced.

  • Must be a decimal number.
use_do_not_call
Optional Blank value allowed

Reject leads whose number is on the Do Not Call list.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
use_dnc_litigators
Optional Blank value allowed

Reject leads whose number belongs to a known DNC litigator.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
reject_number_not_in_service
Optional Blank value allowed

Reject leads whose number is not in service.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyer_suppression_id
Optional Blank value allowed

The Buyer Suppression list used to suppress leads and callers on this schedule.
tcpa_shield_enabled
Optional Blank value allowed

Check leads against TCPA Shield before dialing them.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
tcpa_shield_integration_id
Optional Blank value allowed

The TCPA Shield integration used when tcpa_shield_enabled is true.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
blacklist_alliance_enabled
Optional Blank value allowed

Check leads against Blacklist Alliance before dialing them.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
blacklist_alliance_integration_id
Optional Blank value allowed

The Blacklist Alliance integration used when blacklist_alliance_enabled is true.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
daylight_hours_open
Optional Blank value allowed

The time of day, in HHMM format using the lead’s local time zone, that daylight hours dialing opens.

  • Must be a decimal number.
daylight_hours_close
Optional Blank value allowed

The time of day, in HHMM format using the lead’s local time zone, that daylight hours dialing closes.

  • Must be a decimal number.
scheduled_callback_hours_open
Optional Blank value allowed

The time of day, in HHMM format using the schedule’s time zone, that scheduled callbacks may start being placed.

  • Must be a decimal number.
scheduled_callback_hours_close
Optional Blank value allowed

The time of day, in HHMM format using the schedule’s time zone, that scheduled callbacks stop being placed.

  • Must be a decimal number.
enable_public_show
Optional Blank value allowed

Publish this schedule’s posting instructions page. Turning this on requires the company to have completed identity verification.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
enable_public_index
Optional Blank value allowed

List this schedule’s posting instructions page on the company’s public index.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
public_name
Optional Blank value allowed

The title shown on this schedule’s public posting instructions page.

  • Must be a String
public_description
Optional Blank value allowed

The rich-text description shown on this schedule’s public posting instructions page.

  • Must be a String

POST /schedules/make_call

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/schedules/make_call

Call a lead immediately

Places an outbound call immediately. This is the endpoint to use for a “promote” / “call now” action.

Identifying who to call (choose one):
• lead_id — dials that exact existing Lead. Its number is used as to and its schedule is used to dial. Nothing new is created, so a promote never produces a duplicate lead. This is the recommended option.
• lead_token (a Schedule’s “Leads API Key”) or schedule_id — identifies the Schedule to dial from. You must also pass to (the number to dial).

Schedule / lead distribution routing:
The resolved schedule takes the same code path as POST /api/v1/leads. If it is a lead-distribution (“router”) schedule, the matching distribution is resolved from the submitted data (eg traffic_source_id) and the call is routed to that distribution’s downstream target schedule. If no distribution matches, the request is rejected.

Which lead gets dialed (when using lead_token/schedule_id + to):
• If a live lead is already enrolled in the resolved schedule for that number, it is reused and dialed — no duplicate is created (the “promote” case).
• Otherwise a one-off, offer-owned lead is created and dialed. This places a single call without enrolling the contact into the schedule’s dialing cadence.

Guards enforced before dialing:
• The schedule must be active.
• Account CPS (calls per second) limit.
• DNC / contact suppression rules.
• The same number cannot be dialed more than once every 30 seconds.
• The destination number must be valid.

Returns a serialized Call record on success. Raises errors for an unknown lead_id, an unresolvable or inactive schedule, no matching lead distribution, invalid numbers, suppressed contacts, exceeded CPS, recently-dialed numbers, or duplicate concurrent leads.

Params

Param name Description
lead_id
Optional

The TrackDrive ID (UUID) of an existing Lead to dial. When provided, the call uses this exact lead — its number is dialed and its schedule is used — so to, lead_token and schedule_id are not required and are ignored. This is the preferred way to promote a lead you already created, because it never creates a duplicate.

  • Must be a String
schedule_id
Optional

The ID of the Schedule to dial from. Must belong to the current company and be active. Use this (or lead_token) together with to when you are not passing a lead_id.
lead_token
Optional

The token for the Schedule where you want lead to originate. Get it from: trackdrive.com/schedules

  • Must be a String
to
Optional

Destination phone number to dial. Must be a valid number and not suppressed. Required unless a lead_id is provided (in which case the lead’s number is used).

  • Must be a String
data
Optional

Optional hash of additional lead attributes (eg traffic_source_id). Used to route the lead through a lead-distribution schedule and stored on any lead that is created.

  • Must be a Hash

GET /schedules/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/schedules/:id

Get Schedule by id.

Retrieves a single schedule by its Trackdrive internal ID.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    scheduleDefault response format.
    schedule_gridModern response format that returns various foreign keys for use with other API endpoints.

PUT /schedules/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/schedules/:id

Update Schedule by id.

Updates an existing schedule's settings, such as its name, linked offer, description, paused state, or lead duplicate timeframe. Only the attributes you include are changed.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    scheduleDefault response format.
    schedule_gridModern response format that returns various foreign keys for use with other API endpoints.
name
Optional Blank value allowed

Name

  • Must be a String
offer_id
Optional Blank value allowed

Offer
description
Optional Blank value allowed

A human readable description of the record.

  • Must be a String
paused
Optional Blank value allowed

Paused

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
external_record_id
Optional Blank value allowed

Your own identifier for this schedule, used to correlate it with a record in an external system.

  • Must be a String
off_hook_enabled
Optional Blank value allowed

Turns on Instant Agent Mode, which sends calls to logged-in agents through dial_agents_number_id instead of a Ring Pool or Number.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
dial_agents_number_id
Optional Blank value allowed

The number agents call in to when off_hook_enabled is true.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
action_dial_with_type
Optional Blank value allowed

Whether outbound dialing from this schedule uses a single Number or a Ring Pool.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    numberDial leads using a single tracking number.
    ring_poolDial leads using a pool of tracking numbers.
dial_consumers_number_id
Optional Blank value allowed

The number used to dial leads when action_dial_with_type is number.
dial_caller_name
Optional Blank value allowed

The caller ID name shown to leads when this schedule places a call. Limited to 15 characters.

  • Must be a String
action_dial_skip_mobile
Optional Blank value allowed

Skip dialing lead phone numbers identified as mobile.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
enforce_tcpa_actions_today
Optional Blank value allowed

Only run TCPA-restricted actions when the current day still allows contacting the lead.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
skip_placing_calls_until_agent_count_exceeds
Optional Blank value allowed

Delay placing outbound calls until at least this many agents are logged into the offer.

  • Must be a decimal number.
buyer_is_available_with_qa_agents
Optional Blank value allowed

Treat buyers as available for IVR dialing while agents are in QA.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
instant_agent_dial_weight
Optional Blank value allowed

The relative weight given to this schedule when Instant Agent Mode distributes leads across multiple schedules.

  • Must be a decimal number.
distribute_calls_across_schedules
Optional Blank value allowed

Allow Instant Agent Mode to distribute calls for this schedule across other schedules on the same offer.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
leads_sort_order_type
Optional Blank value allowed

The order leads are dialed in during Instant Agent Mode, eg first_in_first_out or last_in_first_out.

  • Must be a String
real_time_priority
Optional Blank value allowed

The dial priority used when leads_sort_order_type is last_in_first_out.

  • Must be a decimal number.
allow_rtp_after_hours
Optional Blank value allowed

Allow real-time-priority leads to be dialed outside of business hours.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
intersperse_leads
Optional Blank value allowed

Mix in leads sorted by intersperse_sort_order_type alongside the normal dial order.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
intersperse_sort_order_type
Optional Blank value allowed

The sort order used for the interspersed leads when intersperse_leads is true.

  • Must be a String
intersperse_percent
Optional Blank value allowed

The percentage of dialed leads, between 5 and 95, drawn from the interspersed sort order.

  • Must be a decimal number.
available_cc_percentage
Optional Blank value allowed

The percentage of the offer’s concurrency cap this schedule may use for outbound calls. Leave blank for unlimited.

  • Must be a decimal number.
calls_on_hold_limit
Optional Blank value allowed

The maximum number of calls this schedule will hold at once.

  • Must be a decimal number.
callback_expiry_seconds
Optional Blank value allowed

How long, in seconds, a scheduled callback remains valid before it expires.

  • Must be a decimal number.
before_schedule_action_dial_next_action_seconds
Optional Blank value allowed

How long, in seconds, to wait before moving a lead to the next dial action.

  • Must be a decimal number.
use_for_scheduled_callbacks
Optional Blank value allowed

Allow leads on this schedule to be placed into scheduled callbacks.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
enabled_automatically_place_scheduled_callbacks
Optional Blank value allowed

Automatically place scheduled callbacks instead of requiring an agent to dial them manually.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
use_machine_detection
Optional Blank value allowed

Use answering machine detection on outbound calls from this schedule.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
action_sms_use_ring_pool
Optional Blank value allowed

Send SMS actions from a Ring Pool instead of a single number.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
action_sms_ring_pool_id
Optional Blank value allowed

The Ring Pool used to send SMS actions when action_sms_use_ring_pool is true.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
action_sms_number_id
Optional Blank value allowed

The number used to send SMS actions when action_sms_use_ring_pool is false.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
contact_caller_permission_required
Optional Blank value allowed

Require the lead’s permission before running certain schedule actions.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
contact_caller_permission_action_types
Optional Blank value allowed

The action types that require contact caller permission when contact_caller_permission_required is true.

  • Must be an array of strings. EG: ["abc123", "xzy023"]
require_traffic_source_id
Optional Blank value allowed

Reject leads submitted to this schedule without a traffic_source_id.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
lead_traffic_source_reject_duplicates
Optional Blank value allowed

Reject a lead when another lead with the same traffic source already exists on this schedule.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
enforce_contact_field_validations
Optional Blank value allowed

Validate submitted leads against this schedule’s contact field configuration.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
minimum_caller_number_length
Optional Blank value allowed

Reject leads whose phone number has fewer digits than this.

  • Must be a decimal number.
maximum_caller_number_length
Optional Blank value allowed

Reject leads whose phone number has more digits than this.

  • Must be a decimal number.
lead_duplicate_timeframe_scope
Optional Blank value allowed

Whether lead_duplicate_timeframe checks for duplicates within this schedule or across the whole company.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    schedule_idDedupe against leads on this schedule only.
    company_idDedupe against all leads in your account.
max_leads_per_remote_ip
Optional Blank value allowed

The maximum number of leads accepted from the same remote IP within max_leads_per_remote_ip_interval.

  • Must be a decimal number.
max_leads_per_remote_ip_interval
Optional Blank value allowed

The interval, in seconds, over which max_leads_per_remote_ip is enforced.

  • Must be a decimal number.
use_do_not_call
Optional Blank value allowed

Reject leads whose number is on the Do Not Call list.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
use_dnc_litigators
Optional Blank value allowed

Reject leads whose number belongs to a known DNC litigator.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
reject_number_not_in_service
Optional Blank value allowed

Reject leads whose number is not in service.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
buyer_suppression_id
Optional Blank value allowed

The Buyer Suppression list used to suppress leads and callers on this schedule.
tcpa_shield_enabled
Optional Blank value allowed

Check leads against TCPA Shield before dialing them.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
tcpa_shield_integration_id
Optional Blank value allowed

The TCPA Shield integration used when tcpa_shield_enabled is true.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
blacklist_alliance_enabled
Optional Blank value allowed

Check leads against Blacklist Alliance before dialing them.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
blacklist_alliance_integration_id
Optional Blank value allowed

The Blacklist Alliance integration used when blacklist_alliance_enabled is true.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
daylight_hours_open
Optional Blank value allowed

The time of day, in HHMM format using the lead’s local time zone, that daylight hours dialing opens.

  • Must be a decimal number.
daylight_hours_close
Optional Blank value allowed

The time of day, in HHMM format using the lead’s local time zone, that daylight hours dialing closes.

  • Must be a decimal number.
scheduled_callback_hours_open
Optional Blank value allowed

The time of day, in HHMM format using the schedule’s time zone, that scheduled callbacks may start being placed.

  • Must be a decimal number.
scheduled_callback_hours_close
Optional Blank value allowed

The time of day, in HHMM format using the schedule’s time zone, that scheduled callbacks stop being placed.

  • Must be a decimal number.
enable_public_show
Optional Blank value allowed

Publish this schedule’s posting instructions page. Turning this on requires the company to have completed identity verification.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
enable_public_index
Optional Blank value allowed

List this schedule’s posting instructions page on the company’s public index.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off
public_name
Optional Blank value allowed

The title shown on this schedule’s public posting instructions page.

  • Must be a String
public_description
Optional Blank value allowed

The rich-text description shown on this schedule’s public posting instructions page.

  • Must be a String
sortable_order
Optional Blank value allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

  • Must be a decimal number.
lead_duplicate_timeframe
Optional Blank value allowed

The period of time, in seconds, that must elapse before the same caller can create another lead on this schedule.

  • Must be a number.

DELETE /schedules/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/schedules/:id

Destroy Schedule by id.

Soft-deletes a schedule by its Trackdrive internal ID. The schedule stops distributing and dialing leads, but the record is retained rather than permanently erased and can be recovered later.

Params

Param name Description
serializer
Optional Blank value allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    scheduleDefault response format.
    schedule_gridModern response format that returns various foreign keys for use with other API endpoints.