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.

Business Hours & Days API resources relating to business hours and days.

Resource Description
GET /api/v1/business_ranges translation missing: en.api.business_ranges.index
GET /api/v1/business_ranges/new translation missing: en.api.business_ranges.new
POST /api/v1/business_ranges translation missing: en.api.business_ranges.create
GET /api/v1/business_ranges/:id translation missing: en.api.business_ranges.show
PUT /api/v1/business_ranges/:id translation missing: en.api.business_ranges.update
DELETE /api/v1/business_ranges/:id translation missing: en.api.business_ranges.destroy

Buyer Conversions API resource for managing buyer conversions.

Resource Description
GET /api/v1/buyer_conversions List buyer conversions
GET /api/v1/buyer_conversions/new Build a new buyer conversion
POST /api/v1/buyer_conversions Create a buyer conversion
GET /api/v1/buyer_conversions/:id Show the details of a buyer conversion
PUT /api/v1/buyer_conversions/:id Update a buyer conversion
DELETE /api/v1/buyer_conversions/:id Delete a buyer conversion

Buyer Groups The buyer groups in your account.

Resource Description
GET /api/v1/buyer_groups Get buyer groups.
GET /api/v1/buyer_groups/:id Get an individual buyer group by id
POST /api/v1/buyer_groups/:id Update an individual buyer group
PUT /api/v1/buyer_groups/:id Update an individual buyer group
DELETE /api/v1/buyer_groups/:id Destroy an individual buyer group.

Buyers The buyers in your account.

Resource Description
GET /api/v1/buyers Get buyers.
GET /api/v1/buyers/:id Get an individual buyer by id
PUT /api/v1/buyers/:id Update an individual buyer
POST /api/v1/buyers Create a buyer.
DELETE /api/v1/buyers/:id Destroy an individual buyer.

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/reports Get statistics on calls by category.
GET /api/v1/calls/stats Get statistics on calls by category and interval.
GET /api/v1/calls/:id Get a call by id or uuid.
PUT /api/v1/calls/:id Update a call with post_call_tokens.
POST /api/v1/calls/update_buyer/: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.

Contacts The contacts that have dialed your numbers.

Resource Description
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.

Custom Field Mappings Configure data mappings for custom field values. EG: IF interest EQUALS Raccoons THEN send racoons-29838. This is useful for integrating with third-party systems that require you to send internal IDs in Webhook Postbacks.

Resource Description
GET /api/v1/token_value_maps List field mappings.
GET /api/v1/token_value_maps/new Build Field Mapping
POST /api/v1/token_value_maps Create field mapping.
GET /api/v1/token_value_maps/:id Show field mapping.
PUT /api/v1/token_value_maps/:id Update field mapping.
DELETE /api/v1/token_value_maps/:id Delete field mapping.

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

Impressions The impressions recorded by the advertising optimizer.

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

Integrations API resources relating to integrations.

Resource Description
PUT /api/v1/integrations/objects/:id Update the status of an Integration Object.

Leads

Resource Description
POST /api/v1/leads Send leads to your Trackdrive account.
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.
DELETE /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.
GET /api/v1/leads List your leads.
GET /api/v1/leads/:id Get details about a lead.
DELETE /api/v1/leads/:id/id Destory a lead by it's internal id.

Offers The set of offers in your account.

Resource Description
GET /api/v1/offers Get offers.
GET /api/v1/offers/:id Get an offer by id.
PUT /api/v1/offers/:id Update an offer by id.
DELETE /api/v1/offers/:id Destroy an offer by id.

Outgoing Webhook 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

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

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.

Schedule 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

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

Schedules The schedules in your Trackdrive account. Automate placing calls, SMS, Emails, and more to leads.

Resource Description
GET /api/v1/schedules List schedules.
GET /api/v1/schedules/new translation missing: en.api.schedules.new
POST /api/v1/schedules translation missing: en.api.schedules.create
GET /api/v1/schedules/:id Get details about a schedule.
PUT /api/v1/schedules/:id translation missing: en.api.schedules.update
DELETE /api/v1/schedules/:id translation missing: en.api.schedules.destroy

Teams The collection of teams in your account.

Resource Description
GET /api/v1/teams/:id Get a team by id.

Telephone Providers The Phone Providers in your Trackdrive account. One of: Trackdrive, Twilio, and Plivo.

Resource Description
GET /api/v1/provider_configurations List Phone Providers
GET /api/v1/provider_configurations/:id Find Specific Phone Provider
PUT /api/v1/provider_configurations/:id Update Specific Phone Provider

Token Values The token values in your Trackdrive account.

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

Tokens The tokens in your Trackdrive account.

Resource Description
GET /api/v1/tokens List your tokens.
GET /api/v1/tokens/:id Get details about a token.
PUT /api/v1/tokens/:id Update a token.
GET /api/v1/tokens/fields Get details about a token.

Traffic Source Conversions The set of Traffic Source Conversions in your Trackdrive Account.

Resource Description
GET /api/v1/offer_conversions List the Traffic Source Conversions in your Trackdrive Account.
GET /api/v1/offer_conversions/:id Get a Traffic Source Conversion by ID.
POST /api/v1/offer_conversions Create a Traffic Source Conversion.
PUT /api/v1/offer_conversions/:id Update a Traffic Source Conversion by ID.
DELETE /api/v1/offer_conversions/:id Delete a Traffic Source Conversion by ID.

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

translation missing: en.api.lead_alterations.resource.name translation missing: en.api.lead_alterations.resource.short

Resource Description
GET /api/v1/lead_alterations translation missing: en.api.lead_alterations.index
GET /api/v1/lead_alterations/new translation missing: en.api.lead_alterations.new
POST /api/v1/lead_alterations translation missing: en.api.lead_alterations.create
GET /api/v1/lead_alterations/:id translation missing: en.api.lead_alterations.show
PUT /api/v1/lead_alterations/:id translation missing: en.api.lead_alterations.update
DELETE /api/v1/lead_alterations/:id translation missing: en.api.lead_alterations.destroy

translation missing: en.api.schedule_actions.resource.name translation missing: en.api.schedule_actions.resource.short

Resource Description
GET /api/v1/schedule_actions translation missing: en.api.schedule_actions.index
GET /api/v1/schedule_actions/new translation missing: en.api.schedule_actions.new
POST /api/v1/schedule_actions translation missing: en.api.schedule_actions.create
GET /api/v1/schedule_actions/:id translation missing: en.api.schedule_actions.show
PUT /api/v1/schedule_actions/:id translation missing: en.api.schedule_actions.update
DELETE /api/v1/schedule_actions/:id translation missing: en.api.schedule_actions.destroy