API documentation

Agents: Call Dispositions API resource for managing the disposition of calls.

Resource	Description
GET /api/v1/call_dispositions	List records.
GET /api/v1/call_dispositions/new	Build record with defaults.
POST /api/v1/call_dispositions	Create record.
GET /api/v1/call_dispositions/:id	Get record by id.
PUT /api/v1/call_dispositions/:id	Update record by id.
DELETE /api/v1/call_dispositions/:id	Destroy record by id.

Audit Logs An audit log of changes to records in your Trackdrive account.

Resource	Description
GET /api/v1/change_logs	List Change Log records.
GET /api/v1/change_logs/:id	Get Change Log by id.

Billing The billing records in your account.

Resource	Description
GET /api/v1/billings	Get billing records.
GET /api/v1/billings/stats	Get statistical data on billing records grouped by criteria.

Buyer Group API resource for managing Buyer Group.

Resource	Description
GET /api/v1/buyer_groups	List Buyer Group records.
GET /api/v1/buyer_groups/:id	Get Buyer Group by id.
POST /api/v1/buyer_groups/:id	Update Buyer Group by id.
PUT /api/v1/buyer_groups/:id	Update Buyer Group by id.
DELETE /api/v1/buyer_groups/:id	Destroy Buyer Group by id.

Buyer Suppression API resource for managing Buyer Suppression.

Resource	Description
GET /api/v1/buyer_suppressions	List Buyer Suppression records.
GET /api/v1/buyer_suppressions/new	Build Buyer Suppression with defaults.
POST /api/v1/buyer_suppressions	Create Buyer Suppression.
GET /api/v1/buyer_suppressions/:id	Get Buyer Suppression by id.
PUT /api/v1/buyer_suppressions/:id	Update Buyer Suppression by id.
DELETE /api/v1/buyer_suppressions/:id	Destroy Buyer Suppression by id.

Buyers API resource for managing Buyer.

Resource	Description
GET /api/v1/buyers	List the buyers in your Trackdrive account.
GET /api/v1/buyers/:id	Get a buyer record by Trackdrive's internal ID.
GET /api/v1/buyers/:user_buyer_id/by_user_buyer_id	Get a buyer record by your own external ID for the buyer.
PUT /api/v1/buyers/:id	Update a buyer with Trackdrive's internal ID.
GET /api/v1/buyers/new	Build buyer with defaults.
POST /api/v1/buyers	Create a buyer.
DELETE /api/v1/buyers/:id	Delete a buyer with Trackdrive's internal ID.

Calls The phone calls that have been made to and from your account.

Resource	Description
GET /api/v1/calls	List calls.
GET /api/v1/calls/live_calls	List ongoing live calls.
GET /api/v1/calls/reports	Get statistics on calls by category.
GET /api/v1/calls/stats	Get statistics on calls by category and interval.
POST /api/v1/calls	Make an outbound phone call.
GET /api/v1/calls/:id	Get a call by id or uuid.
POST /api/v1/calls/:id	Update a call by `Call ID` or `Call UUID` with contact fields, revenue, payout, and more.
POST /api/v1/calls/update_by_caller_id/:caller_id	Update a call's revenue and buyer_converted using the call's `caller_id` and `offer_token`
DELETE /api/v1/calls/:id	Hang up an ongoing call.

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`

Resource	Description
PUT /api/v1/secure/:secure_token/calls/:uuid	Update a call with `td_secure_token` and `td_uuid` passed in a call's SIP headers.
DELETE /api/v1/secure/:secure_token/calls/:uuid	Hang up an ongoing call using a `td_secure_token` and `td_uuid` passed in a call's SIP headers.

Calls: Logs Get the logs for a call.

Resource	Description
GET /api/v1/call_logs	Get the logs for a call.

Calls: Scheduled Callbacks The Scheduled Callbacks in your account. Calls will be placed to leads when the callback matches.

Resource	Description
GET /api/v1/scheduled_callbacks/new	Returns a new Scheduled Callback
POST /api/v1/scheduled_callbacks	Create a Scheduled Callback
GET /api/v1/scheduled_callbacks/:id	Returns a Scheduled Callback by ID
PUT /api/v1/scheduled_callbacks/:id	Updates a Scheduled Callback by ID
DELETE /api/v1/scheduled_callbacks/:id	Delete a Scheduled Callback by ID

Collections Fetch various collections used in the Trackdrive Interface.

Resource	Description
GET /api/v1/collections/:type	Get a collection.

Contacts The contacts that have dialed your numbers.

Resource	Description
POST /api/v1/contacts/:caller_id/caller_block	Mark a single lead as opt-out. Opted-out leads will no longer be sent SMS, Calls, or Emails.
GET /api/v1/contacts/:id	Get details about a contact.
PUT /api/v1/contacts/:id	Update a contact
DELETE /api/v1/contacts/:id/calls	Hang up all the ongoing calls from a contact.

Datasets

Resource	Description
GET /api/v1/datasets/points	Get datasets
GET /api/v1/datasets/calls/:stat	Get call datasets
GET /api/v1/datasets/leads/:stat	Get call datasets
GET /api/v1/datasets/billing	Get the billing dataset
GET /api/v1/datasets/number_impressions	Get the number impression dataset

Field Mapping Group API resource for managing Field Mapping Group.

Resource	Description
GET /api/v1/token_value_map_groups	List Field Mapping Group records.
GET /api/v1/token_value_map_groups/new	Build Field Mapping Group with defaults.
POST /api/v1/token_value_map_groups	Create Field Mapping Group.
GET /api/v1/token_value_map_groups/:id	Get Field Mapping Group by id.
PUT /api/v1/token_value_map_groups/:id	Update Field Mapping Group by id.
DELETE /api/v1/token_value_map_groups/:id	Destroy Field Mapping Group by id.

Impressions The impressions recorded by the advertising optimizer.

Resource	Description
GET /api/v1/impressions	Advertising optimizer impressions.

Integration API resource for managing Integrations.

Resource	Description
GET /api/v1/integrations	List Integration records.
PUT /api/v1/integrations/objects/:id	Update the status of an Integration Object.
GET /api/v1/integrations/new	Build Integration with defaults.
POST /api/v1/integrations	Create Integration.
GET /api/v1/integrations/:id	Get Integration by id.
PUT /api/v1/integrations/:id	Update Integration by id.
DELETE /api/v1/integrations/:id	Destroy Integration by id.

Lead API resource for managing Lead.

Resource	Description
GET /api/v1/leads	List the leads in your Trackdrive account.
GET /api/v1/leads/:id	Get a lead with Trackdrive's internal ID.
PUT /api/v1/leads/:id	Update a lead with Trackdrive's internal ID.
GET /api/v1/leads/new	Build Lead with defaults.
DELETE /api/v1/leads/:id/id	Destory a lead by it's internal id.
GET /api/v1/leads/reports	Get statistics on leads by category.

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.

Resource	Description
POST /api/v1/leads	Create a lead.
PUT /api/v1/leads/:caller_id/caller_opt_out	Mark a single lead as opt-out. Opted-out leads will no longer be sent SMS, Calls, or Emails.
POST /api/v1/leads/:caller_id/caller_remove	Remove a single lead from a Schedule or Offer. This will prevent ANY additional actions being taken on behalf of the lead.
PUT /api/v1/leads/:caller_id/caller_move_to_end_of_schedule	Move a lead to it's "End Of Schedule Actions". This will make it skip all remaining "Contact Caller Actions"

Number Order API resource for managing Number Orders.

Resource	Description
GET /api/v1/number_orders	List Number Orders.
GET /api/v1/number_orders/new	Build Number Order with defaults.
POST /api/v1/number_orders	Create Number Order.
GET /api/v1/number_orders/:id	Get Number Order by id.
PUT /api/v1/number_orders/:id	Update Number Order by id.
DELETE /api/v1/number_orders/:id	Destroy Number Order by id.

Number Order Prefix API resource for managing Number Order Prefix.

Resource	Description
GET /api/v1/number_order_prefixes	List Number Order Prefix records.
GET /api/v1/number_order_prefixes/new	Build Number Order Prefix with defaults.
POST /api/v1/number_order_prefixes	Create Number Order Prefix.
GET /api/v1/number_order_prefixes/:id	Get Number Order Prefix by id.
PUT /api/v1/number_order_prefixes/:id	Update Number Order Prefix by id.
DELETE /api/v1/number_order_prefixes/:id	Destroy Number Order Prefix by id.

Oauth Connection API resource for managing Oauth Connection.

Resource	Description
GET /api/v1/oauth_connections	List Oauth Connection records.
GET /api/v1/oauth_connections/new	Build Oauth Connection with defaults.
POST /api/v1/oauth_connections	Create Oauth Connection.
GET /api/v1/oauth_connections/:id	Get Oauth Connection by id.
PUT /api/v1/oauth_connections/:id	Update Oauth Connection by id.
DELETE /api/v1/oauth_connections/:id	Destroy Oauth Connection by id.

Offers API resource for managing Offer.

Resource	Description
GET /api/v1/offers	List Offer records.
GET /api/v1/offers/:id	Get Offer by id.
GET /api/v1/offers/new	Build Offer with defaults.
POST /api/v1/offers	Create Offer.
PUT /api/v1/offers/:id	Update Offer by id.
DELETE /api/v1/offers/:id	Destroy Offer by id.

Offers: Agent Scripts API resource for managing an offer's agent scripts.

Resource	Description
GET /api/v1/contact_field_views	List records.
GET /api/v1/contact_field_views/new	Build record with defaults.
POST /api/v1/contact_field_views	Create record.
GET /api/v1/contact_field_views/:id	Get record by id.
PUT /api/v1/contact_field_views/:id	Update record by id.
DELETE /api/v1/contact_field_views/:id	Destroy record by id.

Offers: Call Flow API resource for managing Call Flow. This resource is used to manage rules for Call Handling, Exception Handling, and Hold Queue Handling.

Resource	Description
GET /api/v1/call_routers	List Call Flow records.
GET /api/v1/call_routers/new	Build Call Flow Rule with defaults.
POST /api/v1/call_routers	Create Call Flow Rule.
GET /api/v1/call_routers/:id	Get Call Flow Rule by id.
PUT /api/v1/call_routers/:id	Update Call Flow Rule by id.
DELETE /api/v1/call_routers/:id	Destroy Call Flow Rule by id.

Offers: Contact Fields API resource for managing an offer's contact fields.

Resource	Description
GET /api/v1/contact_fields	List records.
GET /api/v1/contact_fields/new	Build record with defaults.
POST /api/v1/contact_fields	Create record.
GET /api/v1/contact_fields/:id	Get record by id.
PUT /api/v1/contact_fields/:id	Update record by id.
DELETE /api/v1/contact_fields/:id	Destroy record by id.

Offers: Contact Fields: Picklist Values API resource for managing a contact field's picklist values.

Resource	Description
GET /api/v1/contact_field_values	List records.
GET /api/v1/contact_field_values/new	Build record with defaults.
POST /api/v1/contact_field_values	Create record.
GET /api/v1/contact_field_values/:id	Get record by id.
PUT /api/v1/contact_field_values/:id	Update record by id.
DELETE /api/v1/contact_field_values/:id	Destroy record by id.

Offers: Impression Tokens Define the unique url parameters that will be tracked when using Dynamic Number Insertion For example google clickIDs can be tracked: gclid

Resource	Description
GET /api/v1/visitor_token_matchers	List records.
GET /api/v1/visitor_token_matchers/new	Build record with defaults.
POST /api/v1/visitor_token_matchers	Create record.
GET /api/v1/visitor_token_matchers/:id	Get record by id.
PUT /api/v1/visitor_token_matchers/:id	Update record by id.
DELETE /api/v1/visitor_token_matchers/:id	Destroy record by id.

Offers: Optimizer Tokens API resource for managing an offer's optimizer tokens.

Resource	Description
GET /api/v1/token_matchers	List records.
GET /api/v1/token_matchers/new	Build record with defaults.
POST /api/v1/token_matchers	Create record.
GET /api/v1/token_matchers/:id	Get record by id.
PUT /api/v1/token_matchers/:id	Update record by id.
DELETE /api/v1/token_matchers/:id	Destroy record by id.

Offers: Traffic Source Payouts API resource for managing Traffic Source Payouts.

Resource	Description
GET /api/v1/offer_conversions	List Traffic Source Payouts.
GET /api/v1/offer_conversions/new	Build Traffic Source Payout with defaults.
GET /api/v1/offer_conversions/:id	Get Traffic Source Payout by id.
POST /api/v1/offer_conversions	Create Traffic Source Payout.
PUT /api/v1/offer_conversions/:id	Update Traffic Source Payout by id.
DELETE /api/v1/offer_conversions/:id	Destroy Traffic Source Payout by id.

Outgoing Webhooks Webhooks (also known as Postbacks) fire when a triggers occurs, such as a buyer being dialled or a call ending.

Resource	Description
GET /api/v1/outgoing_webhooks	List webhooks
GET /api/v1/outgoing_webhooks/new	Build a new webhook
POST /api/v1/outgoing_webhooks	Create a webhook
GET /api/v1/outgoing_webhooks/:id	Show the details of a webhook
PUT /api/v1/outgoing_webhooks/:id	Update a webhook
DELETE /api/v1/outgoing_webhooks/:id	Delete a webhook

Outgoing Webhooks: Logs API resource for viewing Webhook Request Logs.

Resource	Description
GET /api/v1/webhook_logs	List Webhook Logs.
GET /api/v1/webhook_logs/:id	Show A Webhook Log.

Outgoing Webhooks: Manually Fire A Webhook API resource for manually firing Webhooks for testing purposes.

Resource	Description
GET /api/v1/webhook_manual_fires	List Test Webhooks
GET /api/v1/webhook_manual_fires/new	Build A Manual Webhook Fire Instance
POST /api/v1/webhook_manual_fires	Manually Fire A Webhook
GET /api/v1/webhook_manual_fires/:id	Get A Manually Fired Webhook

Outgoing Webhooks: URLs Configure the URLs that fire when an Outgoing Webhook is triggered.

Resource	Description
GET /api/v1/outgoing_webhook_urls	List webhook urls
GET /api/v1/outgoing_webhook_urls/new	Build a new webhook url
POST /api/v1/outgoing_webhook_urls	Create a webhook url
GET /api/v1/outgoing_webhook_urls/:id	Show the details of a webhook url
PUT /api/v1/outgoing_webhook_urls/:id	Update a webhook url
DELETE /api/v1/outgoing_webhook_urls/:id	Delete a webhook url

Phone Number Pools API resource for managing Phone Number Pool.

Resource	Description
GET /api/v1/ring_pools	List Phone Number Pools.
GET /api/v1/ring_pools/new	Build Phone Number Pool with defaults.
POST /api/v1/ring_pools	Create Phone Number Pool.
GET /api/v1/ring_pools/:id	Get Phone Number Pool by id.
PUT /api/v1/ring_pools/:id	Update Phone Number Pool by id.
DELETE /api/v1/ring_pools/:id	Destroy Phone Number Pool by id.

Phone numbers The phone numbers in your Trackdrive account.

Resource	Description
GET /api/v1/phone_numbers	Get the phone numbers assigned to your account.
POST /api/v1/phone_numbers	Purchase a new phone number using one of your existing provider configurations.
GET /api/v1/phone_numbers/:id	Show the details of phone number
PUT /api/v1/phone_numbers/:id	Update a phone number's traffic source or Number Pool
DELETE /api/v1/phone_numbers/:id	Unrent a phone number.

Playlist API resource for managing Playlist.

Resource	Description
GET /api/v1/sound_playlists	List Playlist records.
GET /api/v1/sound_playlists/new	Build Playlist with defaults.
POST /api/v1/sound_playlists	Create Playlist.
GET /api/v1/sound_playlists/:id	Get Playlist by id.
PUT /api/v1/sound_playlists/:id	Update Playlist by id.
DELETE /api/v1/sound_playlists/:id	Destroy Playlist by id.

Provider Configuration API resource for managing Provider Configuration.

Resource	Description
GET /api/v1/provider_configurations	List Provider Configuration records.
GET /api/v1/provider_configurations/:id	Get Provider Configuration by id.
PUT /api/v1/provider_configurations/:id	Update Provider Configuration by id.

Response Parser API resource for managing Response Parsers.

Resource	Description
GET /api/v1/response_parsers	List Response Parsers
GET /api/v1/response_parsers/new	Build Response Parser with defaults.
POST /api/v1/response_parsers	Create Response Parser.
GET /api/v1/response_parsers/:id	Get Response Parser by id.
PUT /api/v1/response_parsers/:id	Update Response Parser by id.
DELETE /api/v1/response_parsers/:id	Destroy Response Parser by id.

SMS: Incoming Text Messages API resource for managing Incoming Text Message.

Resource	Description
GET /api/v1/incoming_text_messages	List Incoming Text Message records.
GET /api/v1/incoming_text_messages/:id	Get Incoming Text Message by id.

SMS: Outgoing Text Messages Sends a message by submitting an outbound message request.

Resource	Description
POST /api/v1/text_messages	Sends a message by submitting an outbound message request.
GET /api/v1/text_messages	Retrieves details about text messages.
GET /api/v1/text_messages/:id	Retrieves details about a specific text message request.

Schedules API resource for managing Schedules.

Resource	Description
GET /api/v1/schedules	List Schedules.
GET /api/v1/schedules/new	Build Schedule with defaults.
POST /api/v1/schedules	Create Schedule.
GET /api/v1/schedules/:id	Get Schedule by id.
PUT /api/v1/schedules/:id	Update Schedule by id.
DELETE /api/v1/schedules/:id	Destroy Schedule by id.

Schedules: Actions Manage the actions of a schedule.

Resource	Description
GET /api/v1/schedule_actions	List schedule actions.
GET /api/v1/schedule_actions/new	Build a schedule action with default attributes.
POST /api/v1/schedule_actions	Create a schedule action.
GET /api/v1/schedule_actions/:id	Get details about a schedule action.
PUT /api/v1/schedule_actions/:id	Update a schedule action.
DELETE /api/v1/schedule_actions/:id	Destroy a schedule action.

Schedules: 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.

Resource	Description
GET /api/v1/schedule_triggers	Search for Schedule Triggers
GET /api/v1/schedule_triggers/new	Returns a new Schedule Trigger
POST /api/v1/schedule_triggers	Create a Schedule Trigger
GET /api/v1/schedule_triggers/:id	Returns a Schedule Trigger by ID
PUT /api/v1/schedule_triggers/:id	Updates a Schedule Trigger by ID
DELETE /api/v1/schedule_triggers/:id	Delete a Schedule Trigger by ID

Sip Header API resource for managing Sip Header.

Resource	Description
GET /api/v1/sip_headers	List Sip Header records.
GET /api/v1/sip_headers/new	Build Sip Header with defaults.
POST /api/v1/sip_headers	Create Sip Header.
GET /api/v1/sip_headers/:id	Get Sip Header by id.
PUT /api/v1/sip_headers/:id	Update Sip Header by id.
DELETE /api/v1/sip_headers/:id	Destroy Sip Header by id.

Sound File API resource for managing Sound File.

Resource	Description
GET /api/v1/sound_files	List Sound File records.
GET /api/v1/sound_files/new	Build Sound File with defaults.
POST /api/v1/sound_files	Create Sound File.
GET /api/v1/sound_files/:id	Get Sound File by id.
PUT /api/v1/sound_files/:id	Update Sound File by id.
DELETE /api/v1/sound_files/:id	Destroy Sound File by id.

Teams API resource for managing Teams.

Resource	Description
GET /api/v1/access_control_lists	List Teams records.
GET /api/v1/access_control_lists/new	Build Team with defaults.
POST /api/v1/access_control_lists	Create Team
GET /api/v1/access_control_lists/:id	Get Teams by id.
PUT /api/v1/access_control_lists/:id	Update Team by id.
DELETE /api/v1/access_control_lists/:id	Destroy Team by id.

Token API resource for managing Tokens.

Resource	Description
GET /api/v1/tokens	List Tokens.
GET /api/v1/tokens/:id	Get Token by id.
PUT /api/v1/tokens/:id	Update Token by id.
DELETE /api/v1/tokens/:id	Destroy Token by id.
GET /api/v1/tokens/fields	Get Token by id.

Tokens: Values The token values in your Trackdrive account.

Resource	Description
GET /api/v1/token_values	List your token values.

Traffic Sources The traffic sources in your account.

Resource	Description
GET /api/v1/traffic_sources	Get traffic sources matching filters.
POST /api/v1/traffic_sources	Create a new Traffic Source.
GET /api/v1/traffic_sources/:id	Get a Traffic Source by id.
PUT /api/v1/traffic_sources/:id	Update a Traffic Source by id.
DELETE /api/v1/traffic_sources/:id	Destroy a Traffic Source by id.

Webhook Param API resource for managing Webhook Param.

Resource	Description
GET /api/v1/webhook_params	List Webhook Param records.
GET /api/v1/webhook_params/new	Build Webhook Param with defaults.
POST /api/v1/webhook_params	Create Webhook Param.
GET /api/v1/webhook_params/:id	Get Webhook Param by id.
PUT /api/v1/webhook_params/:id	Update Webhook Param by id.
DELETE /api/v1/webhook_params/:id	Destroy Webhook Param by id.

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.

Resource	Description
GET /api/v1/subscriptions	List Subscriptions
GET /api/v1/webhook_subscriptions/new	Build Webhook Subscription with defaults.
POST /api/v1/subscriptions	Create a subscription
GET /api/v1/subscriptions/:id	Get a subscription
PUT /api/v1/subscriptions/:id	Update a subscription
DELETE /api/v1/subscriptions/:id	Delete a subscription
DELETE /api/v1/subscriptions	Delete a subscription matching a target_url

Your Companies API resource for viewing the Trackdrive Companies you can access.

Resource	Description
GET /api/v1/companies	List the Trackdrive Companies you can access.
GET /api/v1/companies/:id	Get Company by id.

Zip CSV File API resource for managing Zip CSV File.

Resource	Description
GET /api/v1/zip_code_list_files	List Zip CSV File records.
GET /api/v1/zip_code_list_files/new	Build Zip CSV File with defaults.
POST /api/v1/zip_code_list_files	Create Zip CSV File.
GET /api/v1/zip_code_list_files/:id	Get Zip CSV File by id.
PUT /api/v1/zip_code_list_files/:id	Update Zip CSV File by id.
DELETE /api/v1/zip_code_list_files/:id	Destroy Zip CSV File by id.

Zip Code List API resource for managing Zip Code List.

Resource	Description
GET /api/v1/zip_code_lists	List Zip Code List records.
GET /api/v1/zip_code_lists/new	Build Zip Code List with defaults.
POST /api/v1/zip_code_lists	Create Zip Code List.
GET /api/v1/zip_code_lists/:id	Get Zip Code List by id.
PUT /api/v1/zip_code_lists/:id	Update Zip Code List by id.
DELETE /api/v1/zip_code_lists/:id	Destroy Zip Code List by id.