Supported Formats

json

Examples

curl -H "Content-Type: application/json" -X POST -d '{"name ":"Great Group Of Buyers", "buyer_ids": [100123,100124]}' https://[your-subdomain].trackdrive.net/api/v1/buyer_groups?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

name
Required

Name

  • Must be String

paused
Optional

Pause or unpause.

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

reset_total_caps
Optional

Send true to reset the total caps on this buyer group.

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

dial_buyers_type
Optional

Dial Buyers Type

  • Must be one of: sequentially, simultaneously.

buyer_ids
Optional Blank Value Allowed

The list of buyer ids that will be dialed.
Example: [100123, 100124, 1000125] Obtain internal buyer IDs by making a request to /api/v1/buyers?columns=name,id,user_buyer_id

  • Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers

tier
Optional

Tier

  • Must be a decimal number.

weight
Optional

Weight

  • Must be a decimal number.

generate_team
Optional

Grant access to manage this buyer group, it's buyers, and to view calls that it's paid for.

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

team_users_emails
Optional Blank Value Allowed

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

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

team_offer_ids
Optional Blank Value Allowed

Team members can view calls made to these Offers that were paid for by the buyers in this group.

  • Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

attempt_total_limit
Optional Blank Value Allowed

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 Blank Value Allowed

Monthly Attempt Cap

  • Must be a decimal number.

attempt_daily_limit
Optional Blank Value Allowed

Daily Attempt Cap

  • Must be a decimal number.

connection_total_limit
Optional Blank Value Allowed

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 Blank Value Allowed

Monthly Connection Cap

  • Must be a decimal number.

connection_daily_limit
Optional Blank Value Allowed

Daily Connection Cap

  • Must be a decimal number.

buyer_conversion_total_limit
Optional Blank Value Allowed

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 Blank Value Allowed

Monthly Conversion Cap

  • Must be a decimal number.

buyer_conversion_daily_limit
Optional Blank Value Allowed

Daily Conversion Cap

  • Must be a decimal number.

revenue_total_limit
Optional Blank Value Allowed

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 Blank Value Allowed

Monthly $ Revenue Cap

  • Must be a decimal number.

revenue_daily_limit
Optional Blank Value Allowed

Daily $ Revenue Cap

  • Must be a decimal number.