API documentation

GET /lead_retargets/new

Authorization Required

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

Build Lead Retargeting with defaults.

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

Params

Param name	Description
description Optional Blank value allowed	Description Must be a String
lead_import_id Optional Blank value allowed	Lead Import Must be a valid foreign key reference to an Lead Import. Refer to: /api/docs/1.0/lead_imports
record_token_filter_id Optional Blank value allowed	Record Token Filter Must be a valid foreign key reference to an Filters. Refer to: /api/docs/1.0/record_token_filters
token_value_ids Optional Blank value allowed	Token Value Ids Must be a decimal number.
record_token_additional_id Optional Blank value allowed	Record Token Additional Must be a String
attribution_token_value_ids Optional Blank value allowed	Attribution Token Value Ids Must be a decimal number.
name Optional Blank value allowed	The name of this retarget, shown in your retarget list. Must be a String
paused Optional Blank value allowed	Pause or unpause this retarget. A paused retarget will not process leads. Must be a boolean value: 1, true, yes, on, 0, false, no, off
data_source_type Optional Blank value allowed	Where to pull leads from: lead_import to retarget leads from an uploaded Lead Import, or schedule to retarget leads currently on a Schedule. Must be one of: `lead_import`, `schedule`.
data_source_schedule_id Optional Blank value allowed	The Schedule to pull leads from, when data_source_type is schedule. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
filter_created_at_from Optional Blank value allowed	Only include leads created on or after this time, when data_source_type is schedule. Must be a String
filter_created_at_to Optional Blank value allowed	Only include leads created on or before this time, when data_source_type is schedule. Must be a String
filter_owner_type Optional Blank value allowed	Only include leads owned by this type of record (Offer or Schedule), when data_source_type is schedule. Must be a String
filter_schedule_trigger_type Optional Blank value allowed	Only include leads whose end of schedule trigger matches this type, when data_source_type is schedule. Must be a String
filter_traffic_source_id Optional Blank value allowed	Only include leads attributed to this Traffic Source. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
form_step_filter_complete Optional Blank value allowed	Whether this retarget’s filter step has been completed. Must be true, along with form_step_actions_complete, for the retarget to run. Must be a boolean value: 1, true, yes, on, 0, false, no, off
form_step_actions_complete Optional Blank value allowed	Whether this retarget’s actions step has been completed. Must be true, along with form_step_filter_complete, for the retarget to run. Must be a boolean value: 1, true, yes, on, 0, false, no, off
add_to_schedule_enabled Optional Blank value allowed	Add matching leads to add_to_schedule_id after this retarget’s actions run. Must be a boolean value: 1, true, yes, on, 0, false, no, off
add_to_schedule_id Optional Blank value allowed	The Schedule to add matching leads to, when add_to_schedule_enabled is true. Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
scrub_is_live Optional Blank value allowed	Exclude leads that are currently live (on an active call) from this retarget. Must be a boolean value: 1, true, yes, on, 0, false, no, off
scrub_opt_out Optional Blank value allowed	Exclude leads whose contact has opted out from this retarget. Must be a boolean value: 1, true, yes, on, 0, false, no, off
scrub_buyer_attempted Optional Blank value allowed	Exclude leads with a call that was attempted to a Buyer within the scrub_buyer_attempted_from/scrub_buyer_attempted_to window. Must be a boolean value: 1, true, yes, on, 0, false, no, off
scrub_buyer_attempted_from Optional Blank value allowed	The start of the window used by scrub_buyer_attempted. Must be a String
scrub_buyer_attempted_to Optional Blank value allowed	The end of the window used by scrub_buyer_attempted. Must be a String
scrub_buyer_connected Optional Blank value allowed	Exclude leads with a call that connected to a Buyer within the scrub_buyer_connected_from/scrub_buyer_connected_to window. Must be a boolean value: 1, true, yes, on, 0, false, no, off
scrub_buyer_connected_from Optional Blank value allowed	The start of the window used by scrub_buyer_connected. Must be a String
scrub_buyer_connected_to Optional Blank value allowed	The end of the window used by scrub_buyer_connected. Must be a String
scrub_buyer_converted Optional Blank value allowed	Exclude leads with a call that converted for a Buyer within the scrub_buyer_converted_from/scrub_buyer_converted_to window. Must be a boolean value: 1, true, yes, on, 0, false, no, off
scrub_buyer_converted_from Optional Blank value allowed	The start of the window used by scrub_buyer_converted. Must be a String
scrub_buyer_converted_to Optional Blank value allowed	The end of the window used by scrub_buyer_converted. Must be a String
scrub_call_disposition_ids Optional Blank value allowed	Exclude leads with a call matching any of these Call Dispositions within the scrub_call_disposition_ids_from/scrub_call_disposition_ids_to window. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
scrub_call_disposition_ids_from Optional Blank value allowed	The start of the window used by scrub_call_disposition_ids. Must be a String
scrub_call_disposition_ids_to Optional Blank value allowed	The end of the window used by scrub_call_disposition_ids. Must be a String
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`
record_token_additional_list Optional Blank value allowed	Assign additional tokens that will be applied to leads and calls by passing a comma separated string of key:value pairs. Must be a valid list of tokens. Example tokens: `buyer_interest:loan,another_token:value`

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "lead_retarget": {
    "id": null,
    "type": "LeadRetarget",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/lead_retargets/new",
    "routes_edit_path": "/lead_retargets/new",
    "external_record_id": null,
    "company_id": 10001,
    "name": "Retarget leads 26/09/24 by Demo Summit Performance Media",
    "description": null,
    "lead_import_id": null,
    "scrub_buyer_connected": null,
    "data_source_type": null,
    "filter_owner_type": "Schedule",
    "add_to_schedule_enabled": null,
    "add_to_schedule_id": null,
    "scrub_buyer_attempted": null,
    "scrub_buyer_converted": true,
    "scrub_call_disposition_ids": null,
    "total_count": 0,
    "retarget_count": 0,
    "paused": true,
    "started_at": null,
    "jobs_generated_at": null,
    "succeeded_at": null,
    "form_step_actions_complete": null,
    "form_steps": {
      "about": true,
      "filter": false,
      "actions": null,
      "progress": null
    },
    "progress_percent": 0,
    "scrub_is_live": true,
    "success_count": null,
    "filter_traffic_source_id": null,
    "filter_dial_tier_greater_than": null,
    "filter_dial_tier_less_than": null,
    "scrub_opt_out": true,
    "filter_schedule_trigger_type": null,
    "data_source_schedule_id": null,
    "filter_created_at_from": "2026-01-15T14:30:00.000Z",
    "filter_created_at_to": "2026-01-15T15:30:00.000Z",
    "scrub_buyer_attempted_from": "2026-01-15T13:30:00.000Z",
    "scrub_buyer_attempted_to": "2026-01-15T15:30:00.000Z",
    "scrub_buyer_connected_from": "2026-01-15T13:30:00.000Z",
    "scrub_buyer_connected_to": "2026-01-15T15:30:00.000Z",
    "scrub_buyer_converted_from": "2026-01-15T13:30:00.000Z",
    "scrub_buyer_converted_to": "2026-01-15T15:30:00.000Z",
    "scrub_call_disposition_ids_from": "2026-01-15T13:30:00.000Z",
    "scrub_call_disposition_ids_to": "2026-01-15T15:30:00.000Z",
    "schedule_action_ids": [],
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_id": null,
    "record_token_additional_data_count": 0,
    "record_token_additional_data": []
  },
  "metadata": {
    "root": "lead_retarget"
  }
}