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
external_machine_detection_sip_uri
Optional Blank value allowed

The SIP address, sip:user@host or sip:user@host:port, of an answering machine detection endpoint that receives the consumer’s live audio on matching calls and reports its result through POST /api/v1/calls/:call_id/machine_detection. Leave blank to use TrackDrive’s built-in detection. Requires the Setup System permission.

  • Must be a String
external_machine_detection_bridge_audio
Optional Blank value allowed

Bridge Audio Both Ways. False, the external detection endpoint only listens to the consumer. True, it is bridged into the call and the consumer hears whatever it sends until it reports a result or the detection window ends. Each INVITE to the endpoint carries X-TD-Outbound-RTP: Enabled or Disabled. Requires the Setup System permission.

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

Comma separated token filters, such as geo:us-ca,score:>=50, that choose which calls use the external detection endpoint. Blank sends every call that uses machine detection to the endpoint. Requires the Setup System permission.

  • Must be a valid list of filters. Example filters:
    "interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"
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