Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X PUT -d '{"tier":"-10","name":"new name"}' https://[your-subdomain].trackdrive.net/api/v1/buyers/:id?auth_token=[your-auth-token]

Params

Param name
Description
auth_token
optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

reset_total_caps
optional
  • Must be a boolean value: true, false, 0, 1

user_buyer_id
optional

Your external ID for this buyer.

  • Must be String

number
optional

The DID or SIP endpoint to call. DID must be prefixed with +{country code}. Example: to dial a number in the USA, enter +1 followed by the 10 digit DID number, in UK it would be +44 followed by the DID number. To transfer a call via SIP, begin the number with 'sip:'.

  • Must be String

name
optional

The name for this buyer that will appear on menus and in logs.

  • Must be String

timeout_seconds
optional

Determines the time in seconds the call should ring. Must be at least 12 seconds. If the call is not answered within the ring timeout value or the default value of 120 s, it is canceled.

  • Must be a decimal number.

dtmf_tones
optional

Play DTMF tones when the call is answered. This is useful when dialing a phone number and an extension. Your provider will dial the number, and when the automated system picks up, sends the DTMF tones to connect to the extension. E.g. If you want to dial the 2410 extension after the call is connected, and you want to wait for a few seconds before sending the extension, add a few leading 'w' characters. Each 'w' character waits 0.5 second before sending a digit. Each 'W' character waits 1 second before sending a digit.

  • Must be a decimal number.

time_zone
optional

Date ranges will be parsed using this time zone.

  • Must be String

paused
optional

Pause or unpause the buyer.

  • Must be a boolean value: true, false, 0, 1

record_calls
optional

Enable or Disable call recordings for this Buyer.

  • Must be a boolean value: true, false, 0, 1

press_one_to_accept
optional

After answering the call the Buyer must Press 1 before being connected to the Caller.
Trackdrive will use the “Press 1 To Accept” call routing from the current Offer.

  • Must be a boolean value: true, false, 0, 1

alerts_no_answer_threshold
optional

Send an alert if this Buyer doesn't answer the phone this many times.

  • Must be a decimal number.

alerts_no_answer_interval
optional

Send an alert if this Buyer doesn't answer the phone in this many minutes.

  • Must be a decimal number.

generate_team
optional

Grant access to edit this Buyer, and view calls that it paid for.

  • Must be a boolean value: true, false, 0, 1

team_users_emails
optional

The selected users will recieve an email invitation to collaborate on your company.

  • Must be an array of emails: ['john-smith@gmail.com', 'example@domain.com']

team_offer_ids
optional

Team members can view calls made to these Offers that were paid for by their Buyer.

  • Must be an array of decimal values: [0, 1, 2, 3]

token_value_ids
optional

Callers will be routed to Buyers with matching tokens.

  • Must be an array of decimal values: [0, 1, 2, 3]

attribution_token_value_ids
optional

When this Buyer is connected to a Caller, the Call will be tagged with these tokens.

  • Must be an array of decimal values: [0, 1, 2, 3]

route_by_type
optional

Configure how calls will be routed to this Buyer. When routing by revenue the tier will be automatically calculated by taking the revenue for the current timeframe * -1.

  • Must be one of: tier, revenue, epc.

tier
optional

When routing by revenue the tier will not be used. Buyers with the lowest tier are considered first for calls (a tier may be negative if needed). For buyers with the same tier, the weight will then be used to calculate the % of calls the buyer gets within that tier.

  • Must be a decimal number.

epc_timeframe
optional

The number of hours used when calculating the EPC. If there are less than Minimum Required Calls in this timeframe the Assumed EPC will be used instead.

  • Must be a decimal number.

epc_assumed_amount
optional

The Assumed EPC will be used until the Buyer has received Minimum Required Calls calls during the EPC Timeframe.

  • Must be a decimal number.

epc_assumed_calls_count
optional

The number of calls required during EPC Timeframe before the real EPC is used insead of the Assumed EPC.

  • Must be a decimal number.

weight
optional

The Weight of this buyer will be divided by the Total Weight of all buyers at this same Tier to get the % of calls this buyer will get within this Tier. Example: 3 buyers at tier 1 with weights of 1, 4, and 10. The total weight of the buyers at Tier 1 is 15 (1 + 4 + 10 = 15). So the buyer with weight 1 gets 1/15%, buyer with weight 4 gets 4/15%, and buyer with weight 10 gets 10/15% of calls going to Tier 1 buyers.

  • Must be a decimal number.

display_caller_id_type
optional

Select which Caller ID will be sent to this Buyer.

  • Must be one of: display_caller_id, display_fake_caller_id, display_trackdrive_number_id.

display_trackdrive_number_id
optional

The Trackdrive number to display when display_caller_id_type=display_trackdrive_number_id

  • Must be a decimal number.

concurrency_cap_limit
optional

Change the currently active concurrency cap. The number of concurrent calls that can be forwarded to a buyer simultaneously.

  • Must be a decimal number.

attempt_total_limit
optional

Attempt caps limit the number of times a buyer can be attempted in a given interval.

  • Must be a decimal number.

attempt_monthly_limit
optional

Monthly Attempt Cap

  • Must be a decimal number.

attempt_daily_limit
optional

Daily Attempt Cap

  • Must be a decimal number.

connection_total_limit
optional

Connection caps limit the number of times a buyer can be connected in a given interval.

  • Must be a decimal number.

connection_monthly_limit
optional

Monthly Connection Cap

  • Must be a decimal number.

connection_daily_limit
optional

Daily Connection Cap

  • Must be a decimal number.

buyer_conversion_total_limit
optional

Conversion caps limit the number of times a buyer can convert in a given interval.

  • Must be a decimal number.

buyer_conversion_monthly_limit
optional

Monthly Conversion Cap

  • Must be a decimal number.

buyer_conversion_daily_limit
optional

Daily Conversion Cap

  • Must be a decimal number.

revenue_total_limit
optional

Revenue caps limit the dollar amount that can be paid by a buyer in a given interval.

  • Must be a decimal number.

revenue_monthly_limit
optional

Monthly $ Revenue Cap

  • Must be a decimal number.

revenue_daily_limit
optional

Daily $ Revenue Cap

  • Must be a decimal number.

current_conversion_revenue_max
optional

The maximum valid revenue for the current time frame.

  • Must be a decimal number.

current_conversion_revenue_min
optional

The minimum valid revenue for the current time frame.

  • Must be a decimal number.

current_conversion_revenue_increment
optional

Bids must be increased/decreased by this amount for the current time frame.

  • Must be a decimal number.

current_conversion_revenue
optional

The number of dollars paid per call in increments of $0.01 for the current time frame.

  • Must be a decimal number.

current_conversion_duration
optional

The number of seconds for a call to payout. If this is set to 0 the call will convert when this buyer is dialed for the current time frame.

  • Must be a decimal number.

current_conversion_duplicate_timeframe
optional

The period of time that must elapse before a buyer will pay for the same caller to be transferred.

  • Must be a decimal number.

current_conversion_name
optional

This name that will appear in call logs.

  • Must be String

buyer_cap_attributes
optional

The cap settings for this buyer.

  • Must be a Hash

buyer_cap_attributes[business_hours_schedule]
optional

[

{
    attempt_hourly_limit: 10,
    connection_hourly_limit: 10,
    conversion_hourly_limit: 10,
    revenue_hourly_limit: 10,
    schedule: [
        {
            day: '0',
            times: ['11:05..13:05', '14:00..15:00']
        },
        {
            day: '1',
            times: ['11:10..18:30', '19:15..23:30']
        }
    ]
}

]

  • Must be an array of any type

buyer_cap_attributes[attempt_hourly_limit]
optional

Hourly Attempt Cap

  • Must be a decimal number.

buyer_cap_attributes[connection_hourly_limit]
optional

Hourly Connection Cap

  • Must be a decimal number.

buyer_cap_attributes[buyer_conversion_hourly_limit]
optional

Hourly Conversion Cap

  • Must be a decimal number.

buyer_cap_attributes[revenue_hourly_limit]
optional

Hourly $ Revenue Cap

  • Must be a decimal number.