PUT /api/v1/leads/:lead_id/lead_opt_out
Mark a lead as opt-out by its Trackdrive lead id. Opted-out leads will no longer be sent SMS, Calls, or Emails. Opt-out applies to the contact, so every lead sharing that caller_id is opted out.

Examples

curl -X PUT -d '' trackdrive.com/api/v1/leads/74da9151-d988-4428-8087-c8dcf47ae9a2/lead_opt_out?lead_token=yourtoken

# The lead id can also be passed as a param:
curl -X PUT -d '' trackdrive.com/api/v1/leads/lead_opt_out?lead_token=yourtoken&lead_id=74da9151-d988-4428-8087-c8dcf47ae9a2

Params

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.

Validations:

  • Must be a String
lead_id
Required

The Trackdrive lead id (uuid) returned in the response when the lead was submitted. Identifies exactly one lead, so updates never touch another lead that shares the same caller_id.

Validations:

  • Must be a String