Suppression Lists API resource for managing suppression lists on offers, schedules, and buyers.

GET /api/v1/buyer_suppressions
List suppression lists.

Params

Param name
Description
ids
Optional

Return records matching these ids.

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

Return the next page of results.

  • Must be a number.
per_page
Optional

How many results to return per page. The default is 25.

  • 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
fulltext
Optional

Search for any record that matches this text

  • Must be a String
time_zone
Optional

Date ranges will be parsed using this time zone.
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
  • name
  • import_file_url
  • status
  • caller_id_column_name
  • headers
  • blocked
  • error_message
  • import_count
  • total_count
  • import_percent
  • started_at
  • failed_at
  • stopped_at
  • succeeded_at
  • buyer_ids
  • offer_ids
  • schedule_ids

  • Must be a String
root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

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

GET /api/v1/buyer_suppressions/new
Build suppression list with defaults.

Params

Param name
Description
name
Optional

Name

  • Must be a String
caller_id_column_name
Optional Blank Value Allowed

Caller Id Column Name

  • Must be a String
buyer_ids
Optional Blank Value Allowed

The list of internal buyer ID's that will use this suppression list.

  • 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

POST /api/v1/buyer_suppressions
Create suppression list.

Params

Param name
Description
name
Required

Name

  • Must be a String
import_file
Optional

Import File

  • Must be a valid file upload.
caller_id_column_name
Optional Blank Value Allowed

Caller Id Column Name

  • Must be a String
buyer_ids
Optional Blank Value Allowed

The list of internal buyer ID's that will use this suppression list.

  • 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

GET /api/v1/buyer_suppressions/:id
Get suppression list by id.

PUT /api/v1/buyer_suppressions/:id
Update suppression list by id.

Params

Param name
Description
name
Optional

Name

  • Must be a String
caller_id_column_name
Optional Blank Value Allowed

Caller Id Column Name

  • Must be a String
buyer_ids
Optional Blank Value Allowed

The list of internal buyer ID's that will use this suppression list.

  • 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
add_buyer_ids
Optional Blank Value Allowed

Append buyers to this record.
For example pass: [100123,100124] in order to append 100123, and 100124 to the list of buyers in the record.
<strong>This is useful when making parallel PUT requests with different add_buyer_ids or remove_buyer_ids values. These add/remove assignments are thread safe.</strong>

  • 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
remove_buyer_ids
Optional Blank Value Allowed

Remove buyers from the record.
For example pass: [100123] in order to delete 100123 from the list of buyers in the record.

  • 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
add_user_buyer_ids
Optional

Append buyers to the record using the buyer field user_buyer_id
For example pass: ["loan-22-en", "loan-23-fr"]

  • Must be an array of strings. EG: ["abc123", "xzy023"]
remove_user_buyer_ids
Optional

Remove buyers from the record using buyer field user_buyer_id
For example pass: ["loan-23-fr"]

  • Must be an array of strings. EG: ["abc123", "xzy023"]

DELETE /api/v1/buyer_suppressions/:id
Destroy suppression list by id.

POST /api/v1/buyer_suppressions/:id/caller_block
Add individual phone numbers to a suppression list.

Examples

curl -H "Content-Type: application/json" -X POST -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -d '{"caller_ids": ["17191231234","17191231235"]}' "https://[your-subdomain].trackdrive.com/api/v1/buyer_suppressions/:id/caller_block"

Params

Param name
Description
caller_ids
Optional

An array of phone numbers to block.

  • Must be an array of strings. EG: ["abc123", "xzy023"]

POST /api/v1/buyer_suppressions/:id/caller_unblock
Remove individual phone numbers from a suppression list.

Examples

curl -H "Content-Type: application/json" -X POST -H "Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY" -d '{"caller_ids": ["17191231234","17191231235"]}' "https://[your-subdomain].trackdrive.com/api/v1/buyer_suppressions/:id/caller_unblock"

Params

Param name
Description
caller_ids
Optional

An array of phone numbers to block.

  • Must be an array of strings. EG: ["abc123", "xzy023"]