API documentation

GET /contact_imports

Authorization Required

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

List Blacklist File records.

List the blacklist (block or unblock) file imports in your account.

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 user_id status data_maps_set name import_file_url data_json error_message import_count total_count started_at stopped_at failed_at succeeded_at unblock_started_at unblock_finished_at apply_block_or_unblock select_import_type import_file_blob description 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/contact_imports/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "contact_imports": [
    {
      "id": 10001,
      "type": "ContactImport",
      "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": "/contact_imports/10001",
      "routes_edit_path": "/contact_imports/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "user_id": 10003,
      "status": null,
      "data_maps_set": true,
      "name": "Block Known Spam Numbers",
      "import_file_url": null,
      "data_json": "{\"data_map_caller_id\":\"caller_id\"}",
      "error_message": null,
      "import_count": null,
      "total_count": null,
      "started_at": null,
      "stopped_at": null,
      "failed_at": null,
      "succeeded_at": null,
      "unblock_started_at": null,
      "unblock_finished_at": null,
      "apply_block_or_unblock": "block",
      "select_import_type": "text_blob",
      "import_file_blob": "+18005550101\n+18005550102",
      "description": "Numbers reported as spam by buyers, blocked in bulk.",
      "headers": null
    },
    {
      "id": 10004,
      "type": "ContactImport",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T14:30:00.000Z",
      "updated_at": "2026-01-15T14:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/contact_imports/10004",
      "routes_edit_path": "/contact_imports/10004/edit",
      "external_record_id": null,
      "company_id": 10002,
      "user_id": 10003,
      "status": null,
      "data_maps_set": true,
      "name": "Example Contact Import (renamed)",
      "import_file_url": null,
      "data_json": "{\"data_map_caller_id\":\"caller_id\"}",
      "error_message": null,
      "import_count": null,
      "total_count": null,
      "started_at": null,
      "stopped_at": null,
      "failed_at": null,
      "succeeded_at": null,
      "unblock_started_at": null,
      "unblock_finished_at": null,
      "apply_block_or_unblock": "block",
      "select_import_type": "text_blob",
      "import_file_blob": "+18005550123",
      "description": null,
      "headers": null
    }
  ],
  "metadata": {
    "root": "contact_imports",
    "page": 1,
    "total_pages": 5,
    "per_page": 2,
    "total_count": 9,
    "next_cursor": 10005
  }
}

GET /contact_imports/new

Authorization Required

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

Build Blacklist File with defaults.

Return a new, unsaved blacklist import pre-filled with defaults.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
import_file Optional Blank value allowed	The file containing phone numbers to block or unblock, used when select_import_type is file. Must be a valid file upload.
apply_block_or_unblock Optional Blank value allowed	Apply Block Or Unblock Must be one of: `block`, `unblock`.
select_import_type Optional Blank value allowed	Upload Import File Or Text Must be one of: `file`, `text_blob`.
import_file_blob Optional Blank value allowed	Text Blob Must be a String
data_map_caller_id Optional Blank value allowed	The column header from your uploaded file that contains the phone numbers to block or unblock. Must be a String

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact_import": {
    "id": null,
    "type": "ContactImport",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/contact_imports/new",
    "routes_edit_path": "/contact_imports/new",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "status": null,
    "data_maps_set": null,
    "name": "Import by Demo Summit Performance Media person1@example.com at 2026-01-15 11:30:00 -0400",
    "import_file_url": null,
    "data_json": null,
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": null,
    "unblock_started_at": null,
    "unblock_finished_at": null,
    "apply_block_or_unblock": "block",
    "select_import_type": "file",
    "import_file_blob": null,
    "description": null,
    "headers": null
  },
  "metadata": {
    "root": "contact_import"
  }
}

POST /contact_imports

Authorization Required

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

Create Blacklist File.

Upload a file or paste a text blob of phone numbers to bulk block or unblock, as set by apply_block_or_unblock. The import is validated on save and then processed asynchronously.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
import_file Optional Blank value allowed	The file containing phone numbers to block or unblock, used when select_import_type is file. Must be a valid file upload.
apply_block_or_unblock Optional Blank value allowed	Apply Block Or Unblock Must be one of: `block`, `unblock`.
select_import_type Optional Blank value allowed	Upload Import File Or Text Must be one of: `file`, `text_blob`.
import_file_blob Optional Blank value allowed	Text Blob Must be a String
data_map_caller_id Optional Blank value allowed	The column header from your uploaded file that contains the phone numbers to block or unblock. Must be a String
description Optional Blank value allowed	A human readable description of this import. Must be a String

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/contact_imports/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Contact Import",
  "apply_block_or_unblock": "block",
  "select_import_type": "text_blob",
  "import_file_blob": "+18005550123"
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "contact_import": {
    "id": 10001,
    "type": "ContactImport",
    "uuid": null,
    "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": "/contact_imports/10001",
    "routes_edit_path": "/contact_imports/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "user_id": 10003,
    "status": null,
    "data_maps_set": true,
    "name": "Example Contact Import",
    "import_file_url": null,
    "data_json": "{\"data_map_caller_id\":\"caller_id\"}",
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": null,
    "unblock_started_at": null,
    "unblock_finished_at": null,
    "apply_block_or_unblock": "block",
    "select_import_type": "text_blob",
    "import_file_blob": "+18005550123",
    "description": null,
    "headers": null
  },
  "metadata": {
    "root": "contact_import"
  }
}

GET /contact_imports/:id

Authorization Required

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

Get Blacklist File by id.

Retrieve a single blacklist import by id, including its processing status.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact_import": {
    "id": 10001,
    "type": "ContactImport",
    "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": "/contact_imports/10001",
    "routes_edit_path": "/contact_imports/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "user_id": 10003,
    "status": null,
    "data_maps_set": true,
    "name": "Block Known Spam Numbers",
    "import_file_url": null,
    "data_json": "{\"data_map_caller_id\":\"caller_id\"}",
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": null,
    "unblock_started_at": null,
    "unblock_finished_at": null,
    "apply_block_or_unblock": "block",
    "select_import_type": "text_blob",
    "import_file_blob": "+18005550101\n+18005550102",
    "description": "Numbers reported as spam by buyers, blocked in bulk.",
    "headers": null
  },
  "metadata": {
    "root": "contact_import"
  }
}

PUT /contact_imports/:id

Authorization Required

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

Update Blacklist File by id.

Update a blacklist import's name or column mapping, typically before it has finished processing.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
import_file Optional Blank value allowed	The file containing phone numbers to block or unblock, used when select_import_type is file. Must be a valid file upload.
apply_block_or_unblock Optional Blank value allowed	Apply Block Or Unblock Must be one of: `block`, `unblock`.
select_import_type Optional Blank value allowed	Upload Import File Or Text Must be one of: `file`, `text_blob`.
import_file_blob Optional Blank value allowed	Text Blob Must be a String
data_map_caller_id Optional Blank value allowed	The column header from your uploaded file that contains the phone numbers to block or unblock. Must be a String

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/contact_imports/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Contact Import (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "contact_import": {
    "id": 10001,
    "type": "ContactImport",
    "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": "/contact_imports/10001",
    "routes_edit_path": "/contact_imports/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "user_id": 10003,
    "status": null,
    "data_maps_set": true,
    "name": "Example Contact Import (renamed)",
    "import_file_url": null,
    "data_json": "{\"data_map_caller_id\":\"caller_id\"}",
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": null,
    "unblock_started_at": null,
    "unblock_finished_at": null,
    "apply_block_or_unblock": "block",
    "select_import_type": "text_blob",
    "import_file_blob": "+18005550123",
    "description": null,
    "headers": null
  },
  "metadata": {
    "root": "contact_import"
  }
}

Params

Must be any combination of:

Params

Params

Params