Lead Import

A CSV upload job that creates or updates leads for an offer or schedule from an uploaded file.

GET /lead_imports

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

List Lead Import records.

List the lead 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.
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
  • offer_id
  • schedule_id
  • owner_type
  • status
  • data_maps_set
  • name
  • data_json
  • error_message
  • import_count
  • total_count
  • paused_at
  • started_at
  • stopped_at
  • failed_at
  • succeeded_at
  • recent_calls_count
  • traffic_source_id
  • lead_priority
  • update_only
  • sub_id
  • off_hook_buyer_id
  • paused
  • pause_leads
  • change_next_action_at
  • set_next_action_at
  • set_next_action_time_zone
  • apply_data_to_calls
  • manage_move_to_another_schedule
  • manage_move_to_another_schedule_id
  • manage_add_to_schedule
  • manage_add_to_schedule_id
  • manage_delete_lead
  • created_count
  • manage_schedule_action
  • manage_opt_out_and_in
  • manage_block_and_unblock
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_data

  • 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 /lead_imports/new

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

Build Lead Import with defaults.

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

POST /lead_imports

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

Create Lead Import.

Upload a CSV file of leads for an offer or schedule. The import does not start until its columns are mapped with data_maps_attributes, so this call alone creates no leads.

Params

Param name Description
data_maps_attributes
Optional Blank value allowed

How the uploaded file’s columns fill in Trackdrive lead fields. Each entry maps one column: td_key is the Trackdrive field the column fills (for example caller_id or email), and ex_key is the column header in your uploaded file. One entry must map td_key caller_id or trackdrive_lead_id, and this mapping is what starts the import. [

{ "td_key": "caller_id", "ex_key": "Phone", "import": "1" },
{ "td_key": "email", "ex_key": "Email", "import": "1" }

]

  • Must be an array of any type

GET /lead_imports/:id

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

Get Lead Import by id.

Retrieve a single lead import by id, including its progress and any error message.

PUT /lead_imports/:id

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

Update Lead Import by id.

Update a lead import's name, column mapping, or lead handling options. Mapping a caller_id or trackdrive_lead_id column with data_maps_attributes starts the import, which creates or updates leads from the uploaded file.

Params

Param name Description
data_maps_attributes
Optional Blank value allowed

How the uploaded file’s columns fill in Trackdrive lead fields. Each entry maps one column: td_key is the Trackdrive field the column fills (for example caller_id or email), and ex_key is the column header in your uploaded file. One entry must map td_key caller_id or trackdrive_lead_id, and this mapping is what starts the import. [

{ "td_key": "caller_id", "ex_key": "Phone", "import": "1" },
{ "td_key": "email", "ex_key": "Email", "import": "1" }

]

  • Must be an array of any type

DELETE /lead_imports/:id

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

Destroy Lead Import by id.

Delete a lead import. Leads it already created are not removed.