Offers

The set of offers in your account.

GET /offers

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

List Offer records.

Search and list the offers (campaigns) in your account, with filtering, sorting, and pagination. Supports JSON or CSV output.

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
    offerDefault response format.
    offer_gridModern response format that returns various foreign keys for use with other API endpoints.
    transcription_offer_configTranscription Offer Config
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: name, schedules_count, numbers_count, buyers_count, agents_count, paused, user_offer_id, calls_count, recent_calls_count, last_call_at, numbers_count, created_at, data_append_type.
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
  • user_offer_id
  • paused
  • numbers_api_key
  • leads_api_key
  • name
  • numbers_count
  • max_cc_count
  • active_cc_count
  • in_progress_count
  • call_routers_attributes
  • lead_token
  • offer_conversion_ids
  • buyers_count
  • buyer_groups_count
  • agents_count
  • vertical_id
  • vertical_options
  • record_token_filter_id
  • record_token_filter_data_count
  • record_token_filter_data
  • record_token_filter_blacklist_alliance_id
  • record_token_filter_blacklist_alliance_data_count
  • record_token_filter_blacklist_alliance_data
  • record_token_filter_tcpa_shield_id
  • record_token_filter_tcpa_shield_data_count
  • record_token_filter_tcpa_shield_data
  • record_token_filter_suppression_list_id
  • record_token_filter_suppression_list_data_count
  • record_token_filter_suppression_list_data

  • Must be a String

GET /offers/:id

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

Get Offer by id.

Retrieve full details of a single offer, including its tracking numbers, call routing, schedules, and conversion payout rules.

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
    offerDefault response format.
    offer_gridModern response format that returns various foreign keys for use with other API endpoints.
    transcription_offer_configTranscription Offer Config

GET /offers/new

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

Build Offer with defaults.

Return a new, unsaved offer pre-filled with defaults, useful for previewing the record shape before creating one.

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
    offerDefault response format.
    offer_gridModern response format that returns various foreign keys for use with other API endpoints.
    transcription_offer_configTranscription Offer Config

POST /offers

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

Create Offer.

Create a new offer, the central object that ties together tracking numbers, call routing, buyers, schedules, and contact fields for a campaign.

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
    offerDefault response format.
    offer_gridModern response format that returns various foreign keys for use with other API endpoints.
    transcription_offer_configTranscription Offer Config
name
Optional Blank value allowed

Give this offer a name. Example: Insurance Calls

  • Must be a String
user_offer_id
Optional Blank value allowed

Give this offer a unique ID. Example: IC001

  • Must be a String
description
Optional Blank value allowed

A human readable description of the record.

  • Must be a String
paused
Optional Blank value allowed

Pause or unpause the offer. Paused offers will reject all calls and disable all schedules.

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

Record Calls

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

Require the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.

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

The Vertical assigned to this offer, used for reporting and Vertical-scoped enrichment.

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

How a caller who calls back the same offer is routed. One of normal, force_previous_buyer, or force_new_buyer.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    normalNormal
    force_previous_buyerForce Previous Buyer
    force_new_buyerForce New Buyer
callback_reconnect_timeframe
Optional Blank value allowed

The number of seconds after a call ends during which a callback is still treated as a repeat call for routing.

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

The buyer IDs eligible to receive a reconnected callback. If blank, no buyers are reconnected.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
callback_reconnect_behaviour
Optional Blank value allowed

The action taken once the reconnect timeframe has passed, for example force_new_buyer.

  • Must be a String
callback_anonymous_ignore_duplicate_timeframe
Optional Blank value allowed

When true, calls from anonymous caller IDs are treated as unique calls instead of being matched to a previous call for the duplicate timeframe.

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

When true, a call is not sent to a buyer who already converted a call from the same caller within the duplicate timeframe.

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

When true, a call is not sent to a buyer who already answered a call from the same caller within the duplicate timeframe.

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

When true, leads submitted to this offer must pass the offer’s contact field validations before they are accepted.

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

When true, a lead submitted to this offer must include 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

When true, a lead is rejected if it duplicates an existing lead from the same traffic source.

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

When true, only the contact field keys configured on this offer are accepted on lead submission.

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

The minimum number of digits accepted in an inbound caller’s phone number.

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

The maximum number of digits accepted in an inbound caller’s phone number.

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

The Map Contact Field Groups applied to leads submitted to this offer.
leads_expire_in_months
Optional Blank value allowed

The number of months a lead remains active before it is automatically archived and removed from delivery.

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

When true, this offer’s public posting instructions page is reachable at its posting instructions link.

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

When true, this offer is listed on the public posting instructions index page.

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

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

  • Must be a String
public_description
Optional Blank value allowed

The HTML description shown on this offer’s public posting instructions page.

  • Must be a String

PUT /offers/:id

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

Update Offer by id.

Update an existing offer's settings, such as its name, status, greeting, timezone, or routing configuration.

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
    offerDefault response format.
    offer_gridModern response format that returns various foreign keys for use with other API endpoints.
    transcription_offer_configTranscription Offer Config
reset_numbers_api_key
Optional

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

Give this offer a name. Example: Insurance Calls

  • Must be a String
user_offer_id
Optional Blank value allowed

Give this offer a unique ID. Example: IC001

  • Must be a String
description
Optional Blank value allowed

A human readable description of the record.

  • Must be a String
paused
Optional Blank value allowed

Pause or unpause the offer. Paused offers will reject all calls and disable all schedules.

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

Record Calls

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

Require the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.

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

The Vertical assigned to this offer, used for reporting and Vertical-scoped enrichment.

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

How a caller who calls back the same offer is routed. One of normal, force_previous_buyer, or force_new_buyer.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    normalNormal
    force_previous_buyerForce Previous Buyer
    force_new_buyerForce New Buyer
callback_reconnect_timeframe
Optional Blank value allowed

The number of seconds after a call ends during which a callback is still treated as a repeat call for routing.

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

The buyer IDs eligible to receive a reconnected callback. If blank, no buyers are reconnected.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]
callback_reconnect_behaviour
Optional Blank value allowed

The action taken once the reconnect timeframe has passed, for example force_new_buyer.

  • Must be a String
callback_anonymous_ignore_duplicate_timeframe
Optional Blank value allowed

When true, calls from anonymous caller IDs are treated as unique calls instead of being matched to a previous call for the duplicate timeframe.

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

When true, a call is not sent to a buyer who already converted a call from the same caller within the duplicate timeframe.

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

When true, a call is not sent to a buyer who already answered a call from the same caller within the duplicate timeframe.

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

When true, leads submitted to this offer must pass the offer’s contact field validations before they are accepted.

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

When true, a lead submitted to this offer must include 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

When true, a lead is rejected if it duplicates an existing lead from the same traffic source.

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

When true, only the contact field keys configured on this offer are accepted on lead submission.

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

The minimum number of digits accepted in an inbound caller’s phone number.

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

The maximum number of digits accepted in an inbound caller’s phone number.

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

The Map Contact Field Groups applied to leads submitted to this offer.
leads_expire_in_months
Optional Blank value allowed

The number of months a lead remains active before it is automatically archived and removed from delivery.

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

When true, this offer’s public posting instructions page is reachable at its posting instructions link.

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

When true, this offer is listed on the public posting instructions index page.

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

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

  • Must be a String
public_description
Optional Blank value allowed

The HTML description shown on this offer’s public posting instructions page.

  • Must be a String

DELETE /offers/:id

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

Destroy Offer by id.

Permanently delete an offer. Fails if the offer still has tracking numbers assigned to it, or if it has calls currently in progress.

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
    offerDefault response format.
    offer_gridModern response format that returns various foreign keys for use with other API endpoints.
    transcription_offer_configTranscription Offer Config