Suppression Lists

Do-not-call lists of phone numbers that block matching contacts from being sent to associated offers, schedules, or buyers.

GET /buyer_suppressions

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

List suppression lists.

Returns the suppression lists configured on the account, used to block matching phone numbers from reaching offers, schedules, or buyers. Supports filtering by ids plus standard pagination and ordering. Restricted to account superusers.

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 /buyer_suppressions/new

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

Build suppression list with defaults.

Returns a suppression list built with default attributes for previewing available fields. It is not saved.

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 /buyer_suppressions

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

Create suppression list.

Creates a new suppression list that can then be attached to offers, schedules, or buyers to block matching phone numbers from reaching them. Restricted to account superusers.

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

The column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.

  • Must be an array of strings. EG: ["abc123", "xzy023"]
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 Blank value allowed

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 Blank value allowed

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"]

GET /buyer_suppressions/:id

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

Get suppression list by id.

Returns a single suppression list by id, including its import status and counts.

PUT /buyer_suppressions/:id

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

Update suppression list by id.

Updates a suppression list's name or the buyers it is attached to. It does not add or remove individual blocked numbers; use caller_block and caller_unblock for that.

Params

Param name Description
name
Optional Blank value allowed

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

The column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name.

  • Must be an array of strings. EG: ["abc123", "xzy023"]
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 /buyer_suppressions/:id

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

Destroy suppression list by id.

Permanently deletes a suppression list. Numbers it contained are no longer blocked once it is removed.

POST /buyer_suppressions/:id/caller_block

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

Add phone numbers to a suppression list

Adds one or more phone numbers to an existing suppression list without replacing the rest of its entries. Numbers are normalized to E.164 and any shorter than 5 digits are rejected.

Params

Param name Description
caller_ids
Optional

An array of phone numbers to block.

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

POST /buyer_suppressions/:id/caller_unblock

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

Remove phone numbers from a suppression list

Removes one or more phone numbers from an existing suppression list, unblocking them going forward.

Params

Param name Description
caller_ids
Optional

An array of phone numbers to block.

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