API documentation

GET /zip_code_lists/new

Authorization Required

https://[your-subdomain].trackdrive.net/api/v1/zip_code_lists/new

Build Zip Code List with defaults.

Return a new, unsaved zip code list pre-filled with defaults.

Params

Param name	Description
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	A CSV file of zip codes to add to this list. Required when creating a list; uploading again on update adds more zip codes to the existing list. Must be a valid file upload.

Param name

Description

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

A CSV file of zip codes to add to this list. Required when creating a list; uploading again on update adds more zip codes to the existing list.

Must be a valid file upload.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "zip_code_list": {
    "id": null,
    "type": "ZipCodeList",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/zip_code_lists/new",
    "routes_edit_path": "/zip_code_lists/new",
    "external_record_id": null,
    "company_id": 10001,
    "name": null,
    "description": null,
    "zip_code_list_file_ids": [],
    "zip_codes_count": 0
  },
  "metadata": {
    "root": "zip_code_list"
  }
}