API documentation

GET /zip_code_list_files

Authorization Required

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

List Zip CSV File records.

Returns Zip CSV File import records, each representing a CSV upload of zip codes into a zip code list.

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 zip_code_list_id name description import_file_url zip_codes sortable_order zip_codes_count started_at stopped_at succeeded_at failed_at 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/zip_code_list_files/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "zip_code_list_files": [
    {
      "id": 10001,
      "type": "ZipCodeListFile",
      "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": "/zip_code_list_files/10001",
      "routes_edit_path": "/zip_code_list_files/10001/edit",
      "external_record_id": null,
      "company_id": 10002,
      "zip_code_list_id": 10003,
      "name": "File",
      "description": null,
      "import_file_url": "https://[your-subdomain].trackdrive.com/zip_code_list_file/10001/download/import_file",
      "zip_codes": null,
      "sortable_order": -1,
      "zip_codes_count": null,
      "started_at": null,
      "stopped_at": null,
      "succeeded_at": null,
      "failed_at": null
    },
    {
      "id": 10004,
      "type": "ZipCodeListFile",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "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": "/zip_code_list_files/10004",
      "routes_edit_path": "/zip_code_list_files/10004/edit",
      "external_record_id": null,
      "company_id": 10002,
      "zip_code_list_id": 10005,
      "name": "File",
      "description": null,
      "import_file_url": "https://[your-subdomain].trackdrive.com/zip_code_list_file/10004/download/import_file",
      "zip_codes": null,
      "sortable_order": -1,
      "zip_codes_count": null,
      "started_at": null,
      "stopped_at": null,
      "succeeded_at": null,
      "failed_at": null
    }
  ],
  "metadata": {
    "root": "zip_code_list_files",
    "page": 1,
    "total_pages": 16,
    "per_page": 2,
    "total_count": 32,
    "next_cursor": 10006
  }
}

GET /zip_code_list_files/new

Authorization Required

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

Build Zip CSV File with defaults.

Returns a Zip CSV File built with default attributes for previewing available fields. It is not saved.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "zip_code_list_file": {
    "id": null,
    "type": "ZipCodeListFile",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/zip_code_list_files/new",
    "routes_edit_path": "/zip_code_list_files/new",
    "external_record_id": null,
    "company_id": 10001,
    "zip_code_list_id": null,
    "name": "Zip Code File",
    "description": null,
    "import_file_url": null,
    "zip_codes": null,
    "sortable_order": null,
    "zip_codes_count": null,
    "started_at": null,
    "stopped_at": null,
    "succeeded_at": null,
    "failed_at": null
  },
  "metadata": {
    "root": "zip_code_list_file"
  }
}

POST /zip_code_list_files

Authorization Required

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

Create Zip CSV File.

Uploads a CSV file of zip codes (import_file) to append to an existing zip code list identified by zip_code_list_id. The file is parsed and imported.

Params

Param name	Description
zip_code_list_id Optional Blank value allowed	Zip Code List Must be a decimal number.
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
import_file Optional Blank value allowed	Import File Must be a valid file upload.

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/zip_code_list_files/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -F 'zip_code_list_id=10001' \
  -F 'name=Example Zip Code File' \
  -F 'import_file=@zip_codes.csv'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "zip_code_list_file": {
    "id": 10002,
    "type": "ZipCodeListFile",
    "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": "/zip_code_list_files/10002",
    "routes_edit_path": "/zip_code_list_files/10002/edit",
    "external_record_id": null,
    "company_id": 10003,
    "zip_code_list_id": 10001,
    "name": "Example Zip Code File",
    "description": null,
    "import_file_url": "https://[your-subdomain].trackdrive.com/zip_code_list_file/10002/download/import_file",
    "zip_codes": null,
    "sortable_order": -2,
    "zip_codes_count": null,
    "started_at": null,
    "stopped_at": null,
    "succeeded_at": null,
    "failed_at": null
  },
  "metadata": {
    "root": "zip_code_list_file"
  }
}

GET /zip_code_list_files/:id

Authorization Required

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

Get Zip CSV File by id.

Returns a single Zip CSV File import by id, including the zip codes it parsed.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "zip_code_list_file": {
    "id": 10001,
    "type": "ZipCodeListFile",
    "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": "/zip_code_list_files/10001",
    "routes_edit_path": "/zip_code_list_files/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "zip_code_list_id": 10003,
    "name": "File",
    "description": null,
    "import_file_url": "https://[your-subdomain].trackdrive.com/zip_code_list_file/10001/download/import_file",
    "zip_codes": null,
    "sortable_order": -1,
    "zip_codes_count": null,
    "started_at": null,
    "stopped_at": null,
    "succeeded_at": null,
    "failed_at": null
  },
  "metadata": {
    "root": "zip_code_list_file"
  }
}

PUT /zip_code_list_files/:id

Authorization Required

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

Update Zip CSV File by id.

Updates a Zip CSV File import's name, description, or associated zip code list.

Params

Param name	Description
zip_code_list_id Optional Blank value allowed	Zip Code List Must be a decimal number.
name Optional Blank value allowed	Name Must be a String
description Optional Blank value allowed	Description Must be a String
import_file Optional Blank value allowed	Import File Must be a valid file upload.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "zip_code_list_file": {
    "id": 10001,
    "type": "ZipCodeListFile",
    "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": "/zip_code_list_files/10001",
    "routes_edit_path": "/zip_code_list_files/10001/edit",
    "external_record_id": null,
    "company_id": 10002,
    "zip_code_list_id": 10003,
    "name": "Example Zip Code File (renamed)",
    "description": null,
    "import_file_url": "https://[your-subdomain].trackdrive.com/zip_code_list_file/10001/download/import_file",
    "zip_codes": null,
    "sortable_order": -3,
    "zip_codes_count": null,
    "started_at": null,
    "stopped_at": null,
    "succeeded_at": null,
    "failed_at": null
  },
  "metadata": {
    "root": "zip_code_list_file"
  }
}

DELETE /zip_code_list_files/:id

Authorization Required

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

Destroy Zip CSV File by id.

Permanently deletes a Zip CSV File import record, along with the zip codes it added to the zip code list.

Example Request

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

Example Response 204

Params

Must be any combination of:

Params

Params