Calls By Third-Party
This resource allows third-party users to update calls using td_secure_token and td_uuid passed in a call's SIP headers. These endpoints do not require authentication with a auth_token
TrackDrive API
Every resource below is available over HTTPS with your company's access token.
Getting started
TrackDrive allows using both basic and token authentication to secure API requests.Company Access Tokens use basic authorization, which requires users or applications to provide a valid set of credentials, including a public and private key combination that is included in the Authorization header of an API request. They provide granular permissions for each keypair, allowing for more fine-grained control over API access.
Developer Access Tokens use token authorization, which requires users or applications to provide a valid auth_token in the Authorization header of an API request. They grant access based on the user's existing permissions, including access to companies the user has permission to access. Basic authorization includes a base64-encoded public and private key combination would look like this:
curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" https://subdomain.trackdrive.com/api/v1/resource Replace BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY with the base64 encoded string of your public key and private key separated by a colon. For example, if your public key is user and private key is pass, you can use the following command to generate the encoded string:
echo -n 'tdpub1234:tdprv1234' | base64 This will output the encoded string dXNlcjpwYXNz. So the final curl command will look like this:
curl -H "Authorization: Basic dXNlcjpwYXNz" https://subdomain.trackdrive.com/api/v1/resource Note that the -n option is used with echo to remove the trailing newline character from the output. Manage Access Tokens
Calls
Call Records
The phone calls that have been made to and from your account.
- GET /calls List calls.
- GET /calls/:caller_number/by_caller_number List calls by caller number.
- GET /calls/live_calls List ongoing live calls.
- GET /calls/reports Get statistics on calls by category.
- GET /calls/stats Get call statistics by category and interval
- POST /calls Make an outbound phone call.
- GET /calls/:id Get a call by id or uuid.
- GET /calls/:id/events Get a call's event log
- POST /calls/:id Update a call by ID or UUID
- POST /calls/update_by_caller_id/:caller_id Update a call's revenue by caller ID
- POST /calls/send_key_press Trigger a key press flow
- DELETE /calls/:id Hang up an ongoing call.
- GET /call_logs Get the logs for a call.
Uncompleted Calls
A log of inbound calls that were rejected or failed to connect, with the reason why.
Scheduled Callbacks
The Scheduled Callbacks in your account. Calls will be placed to leads when the callback matches.
- GET /scheduled_callbacks List scheduled callbacks.
- GET /scheduled_callbacks/new Returns a new Scheduled Callback
- POST /scheduled_callbacks Create a Scheduled Callback
- GET /scheduled_callbacks/:id Returns a Scheduled Callback by ID
- PUT /scheduled_callbacks/:id Updates a Scheduled Callback by ID
- DELETE /scheduled_callbacks/:id Delete a Scheduled Callback by ID
Recording Retention
Rules that automatically delete call recordings after a set retention period, scoped to an offer, schedule, buyer, or traffic source.
- GET /call_recording_rules List Call Recording Retention records.
- GET /call_recording_rules/new Build Call Recording Retention with defaults.
- POST /call_recording_rules Create Call Recording Retention.
- GET /call_recording_rules/:id Get Call Recording Retention by id.
- PUT /call_recording_rules/:id Update Call Recording Retention by id.
- DELETE /call_recording_rules/:id Destroy Call Recording Retention by id.
Leads
Lead By Third-Party
Submit and manage the leads in your Trackdrive account from anywhere with CORS fully whitelisted. These endpoints allow you to submit or opt-out leads using AJAX on behalf of a user visiting your website.
- POST /leads Send leads to your Trackdrive account.
- POST /leads/create_or_update Create or update a lead
- PUT /leads/:caller_id/caller_opt_out Opt out a lead by caller ID
- POST /leads/:caller_id/caller_remove Remove a lead by caller ID
- PUT /leads/:caller_id/caller_move_to_end_of_schedule Requeue a lead by caller ID
- POST /leads/:lead_id/lead_update Update a lead by lead ID
- PUT /leads/:lead_id/lead_opt_out Opt out a lead by lead ID
- POST /leads/:lead_id/lead_remove Remove a lead by lead ID
- PUT /leads/:lead_id/lead_move_to_end_of_schedule Requeue a lead by lead ID
Lead Records
Manage the leads in your Trackdrive account via API.
- GET /leads List your leads.
- GET /leads/:id Get details about a lead.
- GET /leads/:id/buyer_is_available Check whether a lead has a buyer
- GET /leads/:lead_token/:caller_number/by_caller_number Get a lead by caller number
- PUT /leads/:id Update a lead by uuid.
- GET /leads/new Build a new lead with company defaults.
- DELETE /leads/:id/id Destory a lead by it's internal id.
- GET /leads/reports Get statistics on leads by category.
Lead Import
A CSV upload job that creates or updates leads for an offer or schedule from an uploaded file.
Lead Action Logs
A billable record of each action a lead goes through, such as an email, webhook, or schedule step.
Retarget
Reprocesses a saved list of past leads through schedule actions again, optionally filtered by outcome or date.
- GET /lead_retargets List Lead Retargeting records.
- GET /lead_retargets/new Build Lead Retargeting with defaults.
- POST /lead_retargets Create Lead Retargeting.
- GET /lead_retargets/:id Get Lead Retargeting by id.
- PUT /lead_retargets/:id Update Lead Retargeting by id.
- DELETE /lead_retargets/:id Destroy Lead Retargeting by id.
Lead Retarget Logs
API resource for accessing Lead Retarget Logs.
Offers
Offer Settings
The set of offers in your account.
Call Flow
Individual rules in an offer's call flow controlling greetings, IVR menus, dialing, hold queues and exception handling.
Call Flow: Answer Groups
Groups of keypress choices offered to callers during an IVR menu, with shared response-collection settings.
- GET /call_router_answer_groups List Answer Group records.
- GET /call_router_answer_groups/new Build Answer Group with defaults.
- POST /call_router_answer_groups Create Answer Group.
- GET /call_router_answer_groups/:id Get Answer Group by id.
- PUT /call_router_answer_groups/:id Update Answer Group by id.
- DELETE /call_router_answer_groups/:id Destroy Answer Group by id.
Call Flow: Answers
A single keypress option within an IVR menu, defining what happens when a caller presses that key.
Contact Fields
Custom data fields attached to an offer's leads, defining what information is captured and how it's validated.
Contact Fields: Picklist Values
Predefined picklist options and display labels for a contact field that uses a dropdown or select input.
Key Press Flow Groups
Groups the individual key press actions a caller can use during a call into one reusable set.
- GET /key_press_flow_groups List Key Press Flow Group records.
- GET /key_press_flow_groups/new Build Key Press Flow Group with defaults.
- POST /key_press_flow_groups Create Key Press Flow Group.
- GET /key_press_flow_groups/:id Get Key Press Flow Group by id.
- PUT /key_press_flow_groups/:id Update Key Press Flow Group by id.
- DELETE /key_press_flow_groups/:id Destroy Key Press Flow Group by id.
Key Press Flows
Defines what happens when someone on a call presses a specific key, such as ending the call, moving to the next buyer, or applying a call disposition.
- GET /key_press_flows List Key Press Flow records.
- GET /key_press_flows/new Build Key Press Flow with defaults.
- POST /key_press_flows Create Key Press Flow.
- GET /key_press_flows/:id Get Key Press Flow by id.
- PUT /key_press_flows/:id Update Key Press Flow by id.
- DELETE /key_press_flows/:id Destroy Key Press Flow by id.
Advertising Optimizer Tokens
Maps an incoming URL parameter name to a tracking token, so posted data lands in the right field.
Impression Tokens
Define the unique url parameters that will be tracked when using Dynamic Number Insertion For example google clickIDs can be tracked: gclid
- GET /visitor_token_matchers List records.
- GET /visitor_token_matchers/new Build record with defaults.
- POST /visitor_token_matchers Create record.
- GET /visitor_token_matchers/:id Get record by id.
- PUT /visitor_token_matchers/:id Update record by id.
- DELETE /visitor_token_matchers/:id Destroy record by id.
AMD Flows
Rules that detect if a call was answered by a machine or a human and change how the call is routed accordingly.
Real Time Impressions
The impressions recorded by the advertising optimizer.
Ping/Post
Ping/Post By Third-Party
Ping for an available buyer and post a call or lead with the webhook's vanity URI, without an access token.
Ping/Post Settings
Endpoints that let traffic sources ping for an available buyer and post calls or leads for delivery.
- GET /inbound_webhooks List Incoming Webhook records.
- GET /inbound_webhooks/new Build Incoming Webhook with defaults.
- POST /inbound_webhooks Create Incoming Webhook.
- GET /inbound_webhooks/:id Get Incoming Webhook by id.
- PUT /inbound_webhooks/:id Update Incoming Webhook by id.
- DELETE /inbound_webhooks/:id Destroy Incoming Webhook by id.
Ping/Post Logs
Records of every ping/post request an offer's inbound webhook received, for troubleshooting lead delivery.
Buyers
Buyer Settings
The people or companies who pay for your calls and leads, with hours, caps, and conversion rules that define revenue.
- GET /buyers List the buyers in your Trackdrive account.
- GET /buyers/:id Get a buyer by ID
- GET /buyers/:user_buyer_id/by_user_buyer_id Get a buyer by your buyer ID
- PUT /buyers/:id Update a buyer with Trackdrive's internal ID.
- GET /buyers/new Build buyer with defaults.
- POST /buyers Create a buyer.
- DELETE /buyers/:id Delete a buyer with Trackdrive's internal ID.
Buyer Groups
The Buyer Groups in your account.
Buyer Fleets
The Buyer Fleets in your account.
Suppression Lists
Do-not-call lists of phone numbers that block matching contacts from being sent to associated offers, schedules, or buyers.
- GET /buyer_suppressions List suppression lists.
- GET /buyer_suppressions/new Build suppression list with defaults.
- POST /buyer_suppressions Create suppression list.
- GET /buyer_suppressions/:id Get suppression list by id.
- PUT /buyer_suppressions/:id Update suppression list by id.
- DELETE /buyer_suppressions/:id Destroy suppression list by id.
- POST /buyer_suppressions/:id/caller_block Add phone numbers to a suppression list
- POST /buyer_suppressions/:id/caller_unblock Remove phone numbers from a suppression list
Suppression Files
A CSV upload job that bulk adds or removes phone numbers from a buyer suppression list.
- GET /buyer_suppression_files List Suppression File records.
- GET /buyer_suppression_files/new Build Suppression File with defaults.
- POST /buyer_suppression_files Create Suppression File.
- GET /buyer_suppression_files/:id Get Suppression File by id.
- PUT /buyer_suppression_files/:id Update Suppression File by id.
Traffic Sources
Traffic Source Settings
The traffic sources in your account.
- GET /traffic_sources Get traffic sources matching filters.
- GET /traffic_sources/new Build Traffic Source with defaults.
- POST /traffic_sources Create Traffic Source.
- GET /traffic_sources/:id Get Traffic Source by id.
- PUT /traffic_sources/:id Update Traffic Source by id.
- DELETE /traffic_sources/:id Destroy Traffic Source by id.
Conversions Settings
Rules that define when and how much a traffic source is paid when one of its calls converts.
- GET /offer_conversions List Traffic Source Payouts.
- GET /offer_conversions/new Build Traffic Source Payout with defaults.
- GET /offer_conversions/:id Get Traffic Source Payout by id.
- POST /offer_conversions Create Traffic Source Payout.
- PUT /offer_conversions/:id Update Traffic Source Payout by id.
- DELETE /offer_conversions/:id Destroy Traffic Source Payout by id.
Traffic Source Rate Limiters
Manage reusable rate limit configurations for traffic sources.
- GET /traffic_source_rate_limiters List all traffic source rate limiters.
- GET /traffic_source_rate_limiters/new Build a new traffic source rate limiter.
- POST /traffic_source_rate_limiters Create a traffic source rate limiter.
- GET /traffic_source_rate_limiters/:id Show a traffic source rate limiter.
- PUT /traffic_source_rate_limiters/:id Update a traffic source rate limiter.
- DELETE /traffic_source_rate_limiters/:id Delete a traffic source rate limiter.
Traffic Source Rate Limits
Manage per-traffic-source rate limit entries.
- GET /traffic_source_rate_limits List all traffic source rate limits.
- GET /traffic_source_rate_limits/new Build a new traffic source rate limit.
- POST /traffic_source_rate_limits Create a traffic source rate limit.
- GET /traffic_source_rate_limits/:id Show a traffic source rate limit.
- PUT /traffic_source_rate_limits/:id Update a traffic source rate limit.
- DELETE /traffic_source_rate_limits/:id Delete a traffic source rate limit.
Numbers
Phone Numbers
The tracking phone numbers in your Trackdrive account.
- GET /phone_numbers List your phone numbers
- POST /phone_numbers Purchase a phone number
- GET /phone_numbers/:id Show the details of phone number
- PUT /phone_numbers/:id Update a phone number's source or pool
- DELETE /phone_numbers/:id Unrent a phone number.
- GET /phone_numbers/search Search available phone numbers for purchase
Number Pools
A pool of tracking phone numbers assigned to a traffic source; a different number is swapped in per website visitor to attribute their calls.
Virtual Numbers
A SIP-based number that routes calls to an offer without using a real telephone line.
Number Orders
Bulk requests to purchase new tracking numbers from a provider for an offer, pool, traffic source or schedule.
Number Order Prefixes
Phone number area codes or prefixes requested within a number order, with how many numbers to buy for each.
- GET /number_order_prefixes List Number Order Prefix records.
- GET /number_order_prefixes/new Build Number Order Prefix with defaults.
- POST /number_order_prefixes Create Number Order Prefix.
- GET /number_order_prefixes/:id Get Number Order Prefix by id.
- PUT /number_order_prefixes/:id Update Number Order Prefix by id.
- DELETE /number_order_prefixes/:id Destroy Number Order Prefix by id.
Mitigation Numbers
Manage spam-tag mitigation and branded caller ID for your phone numbers. Enabling a number registers it with the mobile carriers to remove "Spam Likely" labels; setting a branded name displays your business name as the caller ID on outbound calls. A one-time business compliance profile must be completed before numbers can be enabled; carriers approve the business in 1-3 business days, then approve each submitted number in about 2-3 weeks.
Telephone Accounts
The Phone Providers in your Trackdrive account. One of: Trackdrive, Twilio, and Plivo.
Schedules
Schedule Settings
The lead distribution and dialing configuration that controls how leads flow through your account and get called.
Triggers
The End Of Schedule Triggers in your account. Leads will be moved to "End Of Schedule Actions" when any of the triggers below match.
- GET /schedule_triggers Search for Schedule Triggers
- GET /schedule_triggers/new Returns a new Schedule Trigger
- POST /schedule_triggers Create a Schedule Trigger
- GET /schedule_triggers/:id Returns a Schedule Trigger by ID
- PUT /schedule_triggers/:id Updates a Schedule Trigger by ID
- DELETE /schedule_triggers/:id Delete a Schedule Trigger by ID
Actions
Manage the actions of a schedule.
- GET /schedule_actions List schedule actions.
- GET /schedule_actions/new Build a schedule action with default attributes.
- POST /schedule_actions Create a schedule action.
- GET /schedule_actions/:id Get details about a schedule action.
- PUT /schedule_actions/:id Update a schedule action.
- DELETE /schedule_actions/:id Destroy a schedule action.
Action Groups
A named, reusable bundle of call actions, such as transferring, hanging up, or sending an SMS, that run together when triggered by an agent status change or a matched transcription.
- GET /schedule_action_groups List Action Group records.
- GET /schedule_action_groups/new Build Action Group with defaults.
- POST /schedule_action_groups Create Action Group.
- GET /schedule_action_groups/:id Get Action Group by id.
- PUT /schedule_action_groups/:id Update Action Group by id.
- DELETE /schedule_action_groups/:id Destroy Action Group by id.
Distributions
Route incoming leads to different schedules based on predefined filters. Configure filters using attributes such as geographic location, interest, lead score, or custom fields. When a new lead is received, the API evaluates these filters to automatically assign the lead to the appropriate schedule. This feature streamlines the lead distribution process, enabling quicker response times and more targeted engagement.
- GET /schedule_distributions List Distribution records.
- GET /schedule_distributions/new Build Distribution with defaults.
- POST /schedule_distributions Create Distribution.
- GET /schedule_distributions/:id Get Distribution by id.
- PUT /schedule_distributions/:id Update Distribution by id.
- DELETE /schedule_distributions/:id Destroy Distribution by id.
Number Pools
Assign multiple number pools to a schedule with filters. When placing outbound calls, the system evaluates filters in sort order and uses the first matching number pool. When no filters match, the last number pool in the list is used as the fallback.
- GET /schedule_ring_pools List Schedule Number Pool records.
- GET /schedule_ring_pools/new Build Schedule Number Pool with defaults.
- POST /schedule_ring_pools Create Schedule Number Pool.
- GET /schedule_ring_pools/:id Get Schedule Number Pool by id.
- PUT /schedule_ring_pools/:id Update Schedule Number Pool by id.
- DELETE /schedule_ring_pools/:id Destroy Schedule Number Pool by id.
Wait Rule Groups
A named collection of wait rules that a schedule matches against to calculate how long to pause a lead.
- GET /lead_wait_rule_groups List Wait Rule Group records.
- GET /lead_wait_rule_groups/new Build Wait Rule Group with defaults.
- POST /lead_wait_rule_groups Create Wait Rule Group.
- GET /lead_wait_rule_groups/:id Get Wait Rule Group by id.
- PUT /lead_wait_rule_groups/:id Update Wait Rule Group by id.
- DELETE /lead_wait_rule_groups/:id Destroy Wait Rule Group by id.
Wait Rules
A rule that sets how long to pause a lead in a schedule, based on its recent call outcomes.
Agents
Call Centers
A group of agents who share softphone settings and can be assigned to handle calls together.
Agent Wizard
Creates an agent account, including its contact details and call center, through a simplified setup wizard.
- GET /schedule_agents List Agent Wizard records.
- GET /schedule_agents/new Build Agent Wizard record with defaults.
- POST /schedule_agents Create Agent with Wizard.
- GET /schedule_agents/:id Get Agent Wizard record by id.
- PUT /schedule_agents/:id Update Agent Wizard record by id.
- DELETE /schedule_agents/:id Destroy Agent Wizard record by id.
Agent Scripts
Agent scripts shown during calls, combining contact field inputs with instructions agents read from and fill in live.
Call Dispositions
Custom outcome codes agents assign to calls that control routing, reporting, and agent workflow behavior.
- GET /call_dispositions List Call Disposition records.
- GET /call_dispositions/new Build Call Disposition with defaults.
- POST /call_dispositions Create Call Disposition.
- GET /call_dispositions/:id Get Call Disposition by id.
- PUT /call_dispositions/:id Update Call Disposition by id.
- DELETE /call_dispositions/:id Destroy Call Disposition by id.
Call Actions
A customizable button agents can click during a call to trigger routing, tagging, or other in-call actions.
- GET /call_control_actions List Call Action records.
- GET /call_control_actions/new Build Call Action with defaults.
- POST /call_control_actions Create Call Action.
- GET /call_control_actions/:id Get Call Action by id.
- PUT /call_control_actions/:id Update Call Action by id.
- DELETE /call_control_actions/:id Destroy Call Action by id.
Agent Messages
A broadcast message sent to selected agents, buyer groups, or call centers through their agent widget.
- GET /agent_messages List Agent Message records.
- GET /agent_messages/new Build Agent Message with defaults.
- POST /agent_messages Create Agent Message.
- GET /agent_messages/:id Get Agent Message by id.
- PUT /agent_messages/:id Update Agent Message by id.
- DELETE /agent_messages/:id Destroy Agent Message by id.
Agent Status Timestamp
A read-only log of when an agent's status changed, used to track availability and timeouts.
SMS
SMS Flows
Automates a text message conversation for an offer, parsing replies and sending follow-up responses.
- GET /text_message_flows List SMS Flow records.
- GET /text_message_flows/new Build SMS Flow with defaults.
- POST /text_message_flows Create SMS Flow.
- GET /text_message_flows/:id Get SMS Flow by id.
- PUT /text_message_flows/:id Update SMS Flow by id.
- DELETE /text_message_flows/:id Destroy SMS Flow by id.
Outgoing SMS
Send a text message
Incoming SMS
Inbound SMS messages received on your tracking numbers, linked to the lead, schedule, and number that received them.
Transcription
Transcripts
A text transcript of a call's audio, including its duration, per-speaker utterances, and any matched keywords.
API Audio Transcriptions
Speech-to-text transcripts generated from an audio file you submit directly, independent of any call or lead.
- GET /standalone_transcriptions List Standalone Transcription records.
- GET /standalone_transcriptions/new Build Standalone Transcription with defaults.
- POST /standalone_transcriptions Create Standalone Transcription.
- GET /standalone_transcriptions/:id Get Standalone Transcription by id.
- DELETE /standalone_transcriptions/:id Destroy Standalone Transcription by id.
Transcription Flow Groups
A named group for organizing related transcription flow configurations.
- GET /transcription_flow_groups List Transcription Flow Group records.
- GET /transcription_flow_groups/new Build Transcription Flow Group with defaults.
- POST /transcription_flow_groups Create Transcription Flow Group.
- GET /transcription_flow_groups/:id Get Transcription Flow Group by id.
- PUT /transcription_flow_groups/:id Update Transcription Flow Group by id.
- DELETE /transcription_flow_groups/:id Destroy Transcription Flow Group by id.
Transcription Flows
Configures which calls get automatically transcribed, based on the recording type (the full call, the consumer-agent leg, or the consumer-buyer leg) and an optional filter, such as call direction or the caller's location.
- GET /transcription_flows List Transcription Flow records.
- GET /transcription_flows/new Build Transcription Flow with defaults.
- POST /transcription_flows Create Transcription Flow.
- GET /transcription_flows/:id Get Transcription Flow by id.
- PUT /transcription_flows/:id Update Transcription Flow by id.
- DELETE /transcription_flows/:id Destroy Transcription Flow by id.
Transcription Keyword Groups
A named group of keywords that Trackdrive spots within call transcriptions to flag calls automatically.
- GET /transcription_keyword_groups List Keyword Group records.
- GET /transcription_keyword_groups/new Build Keyword Group with defaults.
- POST /transcription_keyword_groups Create Keyword Group.
- GET /transcription_keyword_groups/:id Get Keyword Group by id.
- PUT /transcription_keyword_groups/:id Update Keyword Group by id.
- DELETE /transcription_keyword_groups/:id Destroy Keyword Group by id.
Transcription Keyword
Defines keywords or phrases to detect in call transcripts, and which audio channel to scan.
- GET /transcription_keywords List Transcription Keyword records.
- GET /transcription_keywords/new Build Transcription Keyword with defaults.
- POST /transcription_keywords Create Transcription Keyword.
- GET /transcription_keywords/:id Get Transcription Keyword by id.
- PUT /transcription_keywords/:id Update Transcription Keyword by id.
- DELETE /transcription_keywords/:id Destroy Transcription Keyword by id.
Tokens
Token
The tokens in your Trackdrive account.
Values
The token values in your Trackdrive account.
SIP Header Parsing
A named set of rules that pull data out of SIP call headers and save it to a lead.
- GET /sip_header_parser_groups List SIP Header Parsing records.
- GET /sip_header_parser_groups/new Build SIP Header Parsing with defaults.
- POST /sip_header_parser_groups Create SIP Header Parsing.
- GET /sip_header_parser_groups/:id Get SIP Header Parsing by id.
- PUT /sip_header_parser_groups/:id Update SIP Header Parsing by id.
- DELETE /sip_header_parser_groups/:id Destroy SIP Header Parsing by id.
SIP Key
A single rule that maps one SIP header to a contact field, extracting its value onto the lead.
SIP Header
Custom SIP headers attached to a buyer, sent on the SIP leg of a call placed to that buyer.
Routing Rules
State Rules
A named bundle of state-level calling rules (hours, frequency caps, holidays) applied company-wide or to specific offers.
- GET /state_rule_groups List State Call Rules records.
- GET /state_rule_groups/new Build State Call Rules with defaults.
- POST /state_rule_groups Create State Call Rules.
- GET /state_rule_groups/:id Get State Call Rules by id.
- PUT /state_rule_groups/:id Update State Call Rules by id.
- DELETE /state_rule_groups/:id Destroy State Call Rules by id.
Call Frequency
A cap on how many times contacts in specified states can be called within a set time interval.
- GET /state_call_limits List State Call Frequency records.
- GET /state_call_limits/new Build State Call Frequency with defaults.
- POST /state_call_limits Create State Call Frequency.
- GET /state_call_limits/:id Get State Call Frequency by id.
- PUT /state_call_limits/:id Update State Call Frequency by id.
- DELETE /state_call_limits/:id Destroy State Call Frequency by id.
Call Times
Per-state allowed calling hours for each day of the week, used to block outbound calls outside those windows.
- GET /state_business_hours List State Call Time records.
- GET /state_business_hours/new Build State Call Time with defaults.
- POST /state_business_hours Create State Call Time.
- GET /state_business_hours/:id Get State Call Time by id.
- PUT /state_business_hours/:id Update State Call Time by id.
- DELETE /state_business_hours/:id Destroy State Call Time by id.
Holidays
Dates per state on which outbound calling is blocked, such as state-recognized holidays.
- GET /state_holidays List State Holiday records.
- GET /state_holidays/new Build State Holiday with defaults.
- POST /state_holidays Create State Holiday.
- GET /state_holidays/:id Get State Holiday by id.
- PUT /state_holidays/:id Update State Holiday by id.
- DELETE /state_holidays/:id Destroy State Holiday by id.
Zip Codes
A named, reusable list of zip codes used to include or exclude leads by location in filters.
- GET /zip_code_lists List Zip Code List records.
- GET /zip_code_lists/new Build Zip Code List with defaults.
- POST /zip_code_lists Create Zip Code List.
- GET /zip_code_lists/:id Get Zip Code List by id.
- PUT /zip_code_lists/:id Update Zip Code List by id.
- DELETE /zip_code_lists/:id Destroy Zip Code List by id.
Zip Code List Files
A CSV file of zip codes imported to populate or update a Zip Code List.
- GET /zip_code_list_files List Zip CSV File records.
- GET /zip_code_list_files/new Build Zip CSV File with defaults.
- POST /zip_code_list_files Create Zip CSV File.
- GET /zip_code_list_files/:id Get Zip CSV File by id.
- PUT /zip_code_list_files/:id Update Zip CSV File by id.
- DELETE /zip_code_list_files/:id Destroy Zip CSV File by id.
Contacts & Blacklist
Blacklist
The contacts that have dialed your numbers.
- GET /contacts/suppression_list List contacts on your company blacklist.
- POST /contacts/:caller_id/caller_block Blacklist a caller ID
- POST /contacts/:caller_id/caller_unblock Remove a caller from your company blacklist.
- GET /contacts/:id Get details about a contact.
- PUT /contacts/:id Update a contact
- DELETE /contacts/:id/calls Hang up a contact's ongoing calls
Blacklist: Files
API resource for uploading blacklist files.
Blacklist: Clear Blacklist
API resource for removing all numbers from your blacklist.
Webhooks
Event Triggers
Webhooks (also known as Postbacks) fire when a triggers occurs, such as a buyer being dialed or a call ending.
Webhook URLs
Configure the URLs that fire when an Outgoing Webhook is triggered.
- GET /outgoing_webhook_urls List webhook urls
- GET /outgoing_webhook_urls/new Build a new webhook url
- POST /outgoing_webhook_urls Create a webhook url
- GET /outgoing_webhook_urls/:id Show the details of a webhook url
- PUT /outgoing_webhook_urls/:id Update a webhook url
- DELETE /outgoing_webhook_urls/:id Delete a webhook url
Webhook Param
A custom key and value pair appended to an outgoing webhook request, often filled with token data.
- GET /webhook_params List Webhook Param records.
- GET /webhook_params/new Build Webhook Param with defaults.
- POST /webhook_params Create Webhook Param.
- GET /webhook_params/:id Get Webhook Param by id.
- PUT /webhook_params/:id Update Webhook Param by id.
- DELETE /webhook_params/:id Destroy Webhook Param by id.
Webhook Logs
API resource for viewing Webhook Request Logs.
Webhook Subscriptions
Subscribe to events and then wait for Trackdrive to deliver the payload when things happen. The gist is: you POST a subscription to /api/v1/subscription/ requesting to receive hooks at some target URL. Every time the event happens, Trackdrive pings you at the target URL with the payload.
- GET /subscriptions List Subscriptions
- GET /subscriptions/new Build Webhook Subscription with defaults.
- POST /subscriptions Create a subscription
- GET /subscriptions/:id Get a subscription
- PUT /subscriptions/:id Update a subscription
- DELETE /subscriptions/:id Delete a subscription
- DELETE /subscriptions Delete a subscription matching a target_url
Integrations
Integration
A connection to a third-party service or tool that your account uses to send or receive data.
- GET /integrations List Integration records.
- PUT /integrations/objects/:id Update the status of an Integration Object.
- GET /integrations/new Build Integration with defaults.
- POST /integrations Create Integration.
- GET /integrations/:id Get Integration by id.
- PUT /integrations/:id Update Integration by id.
- DELETE /integrations/:id Destroy Integration by id.
Zoho Action
An automated action that syncs lead or call data to Zoho CRM, such as creating or updating a record.
- GET /zoho_crm_commands List Zoho Action records.
- GET /zoho_crm_commands/new Build Zoho Action with defaults.
- POST /zoho_crm_commands Create Zoho Action.
- GET /zoho_crm_commands/:id Get Zoho Action by id.
- PUT /zoho_crm_commands/:id Update Zoho Action by id.
- DELETE /zoho_crm_commands/:id Destroy Zoho Action by id.
Secret
Encrypted key-value secrets stored per account for securely referencing sensitive values like API keys in configurations.
Playlists
Sound Playlists
An ordered or shuffled group of audio files played back together, such as hold music or IVR prompts.
Sound Files
An uploaded audio clip used in call flows and playlists, such as a greeting or hold message.
Reports & Exports
Data Exports
A one-time or recurring export of your account data that runs asynchronously and produces a downloadable file.
Lead & Call Logs
A lead & call log of changes to records in your Trackdrive account.
Collections
Fetch various collections used in the Trackdrive Interface.
Audit Logs
An audit log of system-related changes in your Trackdrive account.
Account
My Companies
API resource for viewing the Trackdrive Companies you can access.
Teams
Defines a team's permission policy, controlling which records, actions, and leads its members can access.
Billing
API resource for viewing billing information.