# Submit leads with a simple HTTP request curl -X POST trackdrive.com/api/v1/leads?lead_token=yourtoken&caller_id=17193132645&email=john@gmail.com&custom_token=the_value&loan_amount=500
# Submit leads as JSON: curl -H "Content-Type: application/json" -X POST -d '{"caller_id":"+18004506787","data":{"loan_amount":"501"}}' "https://trackdrive.com/api/v1/leads?lead_token=yourtoken"
Param name |
Description
Validations
|
---|---|
lead_token Optional |
The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.
|
caller_id Optional |
The callerID for the lead. This is the number Trackdrive will dial when making outbound calls to the lead. This is also the number where Trackdrive will send SMS.
|
email Optional |
The email address for the lead. The lead's email is required for sending emails from schedules to leads.
|
contact_field_type Optional |
Pass an ID belonging to an
|
schedule_callback_at Optional |
Schedule a callback with the submitted lead. Must be a valid time EG: 2021-07-23 14:26:43 +0000
|
schedule_callback_in_seconds Optional |
Schedule a callback with the submitted lead in X seconds. Must be a valid integer EG: 3600
|
update_all_matching_leads Optional |
If this is true, then the data sent in this request will be applied to all leads that match the Offer or Schedule and caller_id sent in the request. An example usecase is if you are sending a tracking token and want it applied to a lead that is present on two schedules (auto, life) under one offer (insurance)
|
apply_to Optional |
Should the data you're sending also be applied to calls associated with this lead?
|
unblock_contact Optional |
Remove the caller_id from the company blacklist. Usage of this param requires passing an auth_token with permission to update Leads.
|
blocked Optional |
Set this to true in order to prevent this lead from calling any of your telephone numbers. This will also prevent all outbound actions from Trackdrive.
|
assign_trackdrive_number Optional |
Assign a dialing number and return it in the API response as trackdrive_number_plain
|
assign_sms_number Optional |
Assign an SMS number and return it in the API response as sms_number_plain
|
expire_existing Optional |
Expire existing live schedule leads that match the lead_token and caller_id
|
delete_existing Optional |
Delete existing leads that match the lead_token and caller_id
|
update_only Optional |
Only update leads that are still active. When true Trackdrive will only update existing active leads. New leads will not be created. Leads that have completed all their actions will not be updated.
|
restart_schedule Optional |
Restart the schedule for the lead from the beginning.
|
auto_format_nested_fields Optional |
Automatically extract contact fields that are nested inside non-standard incoming POST.
|
next_action_at Optional |
Change when the next action is scheduled to run. EG If you mistakenly scheduled leads to wait until next week, you can use this to bulk update them to run 1 second from now.
|
hours_to_expire Optional |
Expire the lead after this many hours. The lead will exit schedule and perform end of schedule actions.
|
max_contact_attempts Optional |
Expire the lead after this many outbound calls + SMS. The lead will exit schedule and perform end of schedule actions.
|
data Optional |
Trackdrive will convert this hash of JSON data into tokens. Inbound and Outbound calls made and received from this Lead will automatically inherit these tokens.
|
curl -X PUT -d '' trackdrive.com/api/v1/leads/17193132645/caller_opt_out?lead_token=yourtoken # GET requests are supported curl trackdrive.com/api/v1/leads/17193132645/caller_opt_out?lead_token=yourtoken
Param name |
Description
Validations
|
---|---|
lead_token Required |
The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.
|
curl -X POST trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken curl -X DELETE trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken # GET requests are supported curl trackdrive.com/api/v1/leads/17193132645/caller_remove?lead_token=yourtoken
Param name |
Description
Validations
|
---|---|
lead_token Required |
The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.
|
curl -X POST -d '' trackdrive.com/api/v1/leads/17193132645/caller_move_to_end_of_schedule?lead_token=yourtoken
Param name |
Description
Validations
|
---|---|
lead_token Required |
The lead token is set to either the offer_lead_token you get at trackdrive.com/offers or a schedule_lead_token you get from trackdrive.com/schedules. The only difference is the use of offer_lead_token will just send data to the offer which is picked up when a call is made with the caller_id of the lead. EG: If a Call Center is transferring data before they send you a call. The schedule_lead_token will start the actions associated with the schedule.
|