POST /api/v1/buyer_groups/:id
Create Buyer Group.

Examples

curl -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -H "Content-Type: application/json" -X POST -d '{"name ":"Great Group Of Buyers", "buyer_ids": [100123,100124]}' https://[your-subdomain].trackdrive.com/api/v1/buyer_groups

Params

Param name
Description
Validations
name
Required

The name of the buyer group.

Validations:

  • Must be a String
paused
Optional

Pause or unpause.

Validations:

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

Validations:

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

Configure the dial buyer behaviour.
sequentially will dial one buyer a time.
simultaneously will dial all buyers in the group at the same time.

Validations:

  • 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

Validations:

  • 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

When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
Buyers and Buyer Groups with the lowest tier are considered first for calls (a tier may be negative if needed).
For buyers/buyer groups with the same tier, the weight will then be used to calculate the % of calls the buyer/buyer group gets within that tier.

Validations:

  • Must be a decimal number.
weight
Optional

When dial_buyers_type is set to simultaneously, the buyer group will become prioritized by tier and weight.
The Weight of this buyer group will be divided by the Total Weight of all buyers/buyer groups at this same Tier to get the % of calls this buyer/buyer group will get within this Tier.

Validations:

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

Validations:

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

Validations:

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

Validations:

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

Validations:

  • Must be a decimal number.
attempt_monthly_limit
Optional Blank Value Allowed

Monthly Attempt Cap

Validations:

  • Must be a decimal number.
attempt_daily_limit
Optional Blank Value Allowed

Daily Attempt Cap

Validations:

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

Validations:

  • Must be a decimal number.
connection_monthly_limit
Optional Blank Value Allowed

Monthly Connection Cap

Validations:

  • Must be a decimal number.
connection_daily_limit
Optional Blank Value Allowed

Daily Connection Cap

Validations:

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

Validations:

  • Must be a decimal number.
buyer_conversion_monthly_limit
Optional Blank Value Allowed

Monthly Conversion Cap

Validations:

  • Must be a decimal number.
buyer_conversion_daily_limit
Optional Blank Value Allowed

Daily Conversion Cap

Validations:

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

Validations:

  • Must be a decimal number.
revenue_monthly_limit
Optional Blank Value Allowed

Monthly $ Revenue Cap

Validations:

  • Must be a decimal number.
revenue_daily_limit
Optional Blank Value Allowed

Daily $ Revenue Cap

Validations:

  • Must be a decimal number.