Supported Formats

json

Examples

curl -X PUT "https://trackdrive.net/api/v1/leads/17193132645?opt_out=true"

# Update leads with application/json:
curl -H "Content-Type: application/json" -X PUT -d '{"opt_out":true}' "https://trackdrive.net/api/v1/leads/17193132645"

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

contact_field_type
Optional Blank Value Allowed

Pass an ID belonging to an Agent Script & Field Type to select that Custom Contact Field Type for this call.

  • Must be String

caller_id
Optional Blank Value Allowed

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.

  • Must be String

blocked
Optional Blank Value Allowed

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.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

opt_out
Optional Blank Value Allowed

Select leads that have opted-out.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

email
Optional Blank Value Allowed

The email address for the lead. The lead's email is required for sending emails from schedules to leads.

  • Must be String

traffic_source_id
Optional Blank Value Allowed

Update the traffic source associated with this lead.

next_action_at
Optional Blank Value Allowed

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.

  • Must be a valid time: 2021-06-18 14:56:00 +0000

schedule_start
Optional Blank Value Allowed

translation missing: en.api.leads.schedule_start

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

schedule_stop
Optional Blank Value Allowed

Removes the lead from the Schedule. No further actions will be taken.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

apply_to
Optional Blank Value Allowed

Should the data you're sending also be applied to calls associated with this lead?

  • Must be one of: calls, self.

data
Optional Blank Value Allowed

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. {interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'} Emails and SMS also have access to these tokens, so it's possible to send email and SMS messages that substitute tokens with values, such as {{first_name}}. Example SMS: “Hello {{first_name}} {{last_name}}, thanks for you inquiry. We will be calling you in 30 seconds from {{trackdrive_number}}”

  • Must be Hash