API documentation

GET /buyer_suppression_files

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files

List Suppression File records.

List the caller ID files that have been imported against your Buyer Suppression lists, including their processing status and counts.

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. Must be a valid time zone. See the list of valid time zones.
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 company_id name buyer_suppression_id apply_block_or_unblock import_file_url user_id status caller_id_column_name error_message import_count total_count started_at stopped_at failed_at succeeded_at headers 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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "buyer_suppression_files": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "BuyerSuppressionFile",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "company_id": 10001,
      "name": "Seeded Import",
      "buyer_suppression_id": 10002,
      "apply_block_or_unblock": "block",
      "import_file_url": null,
      "user_id": 10003,
      "status": "success",
      "caller_id_column_name": "caller_id",
      "error_message": null,
      "import_count": null,
      "total_count": null,
      "started_at": null,
      "stopped_at": null,
      "failed_at": null,
      "succeeded_at": "2026-01-15T15:30:00.000Z",
      "headers": null
    }
  ],
  "metadata": {
    "root": "buyer_suppression_files",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 1,
    "next_cursor": 10004
  }
}

GET /buyer_suppression_files/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/new

Build Suppression File with defaults.

Return a blank Suppression File populated with default attribute values, useful for building a create form.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
buyer_suppression_id Optional Blank value allowed	Buyer Suppression Must be a valid foreign key reference to an Buyer Suppression. Refer to: /api/docs/1.0/buyer_suppressions
apply_block_or_unblock Optional Blank value allowed	Apply Block Or Unblock Must be a String
import_file Optional Blank value allowed	Import File Must be a valid file upload.
caller_id_column_name Optional Blank value allowed	Caller Id Column Name Must be a String
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"]`

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "buyer_suppression_file": {
    "id": null,
    "type": "BuyerSuppressionFile",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/buyer_suppression_files/new",
    "routes_edit_path": "/buyer_suppression_files/new",
    "external_record_id": null,
    "company_id": 10001,
    "name": null,
    "buyer_suppression_id": null,
    "apply_block_or_unblock": "block",
    "import_file_url": null,
    "user_id": null,
    "status": null,
    "caller_id_column_name": null,
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": null,
    "headers": null
  },
  "metadata": {
    "root": "buyer_suppression_file"
  }
}

POST /buyer_suppression_files

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files

Create Suppression File.

Upload a file of caller IDs to bulk block or unblock numbers against a Buyer Suppression list. The named column supplies the caller ID, and the file is processed asynchronously; check status, counts, and any error message via the show or index endpoints.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
buyer_suppression_id Optional Blank value allowed	Buyer Suppression Must be a valid foreign key reference to an Buyer Suppression. Refer to: /api/docs/1.0/buyer_suppressions
apply_block_or_unblock Optional Blank value allowed	Apply Block Or Unblock Must be a String
import_file Optional Blank value allowed	Import File Must be a valid file upload.
caller_id_column_name Optional Blank value allowed	Caller Id Column Name Must be a String
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"]`

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -F 'buyer_suppression_id=10001' \
  -F 'apply_block_or_unblock=block' \
  -F 'caller_id_column_name=caller_id' \
  -F 'name=Example Suppression File' \
  -F 'import_file=@buyer_suppression_files.csv'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "buyer_suppression_file": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "BuyerSuppressionFile",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10002,
    "name": "Example Suppression File",
    "buyer_suppression_id": 10001,
    "apply_block_or_unblock": "block",
    "import_file_url": "https://[your-subdomain].trackdrive.com/buyer_suppression_file/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/download/import_file",
    "user_id": null,
    "status": null,
    "caller_id_column_name": "caller_id",
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": null,
    "headers": [
      "caller_id"
    ]
  },
  "metadata": {
    "root": "buyer_suppression_file"
  }
}

GET /buyer_suppression_files/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/:id

Get Suppression File by id.

Get the processing status, row counts, and any error message for a single Suppression File import by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "buyer_suppression_file": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "BuyerSuppressionFile",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "name": "Seeded Import",
    "buyer_suppression_id": 10002,
    "apply_block_or_unblock": "block",
    "import_file_url": null,
    "user_id": 10003,
    "status": "success",
    "caller_id_column_name": "caller_id",
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": "2026-01-15T15:30:00.000Z",
    "headers": null
  },
  "metadata": {
    "root": "buyer_suppression_file"
  }
}

PUT /buyer_suppression_files/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/:id

Update Suppression File by id.

Update a Suppression File's name or the caller ID column it imports from; the apply_block_or_unblock setting can only be chosen when the file is created. If the file has not finished importing, saving this update also resumes its background processing.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
buyer_suppression_id Optional Blank value allowed	Buyer Suppression Must be a valid foreign key reference to an Buyer Suppression. Refer to: /api/docs/1.0/buyer_suppressions
apply_block_or_unblock Optional Blank value allowed	Apply Block Or Unblock Must be a String
import_file Optional Blank value allowed	Import File Must be a valid file upload.
caller_id_column_name Optional Blank value allowed	Caller Id Column Name Must be a String
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"]`

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Suppression File (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "buyer_suppression_file": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "BuyerSuppressionFile",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/buyer_suppression_files/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "name": "Example Suppression File (renamed)",
    "buyer_suppression_id": 10002,
    "apply_block_or_unblock": "block",
    "import_file_url": "https://[your-subdomain].trackdrive.com/buyer_suppression_file/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/download/import_file",
    "user_id": null,
    "status": null,
    "caller_id_column_name": "caller_id",
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": null,
    "headers": [
      "caller_id"
    ]
  },
  "metadata": {
    "root": "buyer_suppression_file"
  }
}

Params

Must be any combination of:

Params

Params

Params