Provide Lead API - Documentation

Integration Guide

Submit vehicle shipping requests using the Provide Lead API. Edit the JSON payload below and submit to test.

POST/api/v1/Leads/ProvideLead

Base URL: https://api.carlink.pro

JSON Payload

Edit the payload below and click Submit to send the request

Field Reference

lpKey

please request your api key from CarLink

firstName, lastName

Customer name

email, phone

Contact information

phoneOther, fax

Additional contact info

originCity, originState, originZip, originCountry

Pickup location

billingAddress

Complete address

destinationCity, destinationState, destinationZip, destinationCountry

Delivery location

estShipDate

Format: YYYY-MM-DD

isInoperable

Are vehicles inoperable? (boolean)

shipVia

Shipping method (number) 0: Open, 1: Enclosed, 2: Driveaway

noteFromShipper

Special instructions (string)

vehicles

Array of vehicle objects

* Required Fields: lpKey, firstName, email, phone, originZip, destinationZip, estShipDate, vehicles (at least one vehicle object) year,make,model.

Vehicle Types

ATV, BOAT, CAR, HEAVY_EQUIPMENT, LARGE_YACHT, MOTORCYCLE, PICKUP, RV, SUV, TRAVEL_TRAILER, VAN, OTHER

Explanation

External lead providers and partners can download the full integration instructions in DOCX format for offline use and internal sharing.