API Integration Information

Add a Lead

This API call will add a new lead to Carro Systems for the dealer who is listed in your DealerID key in the data packet sent. Other methods available are Add Customer which adds a customer to the system and Update Customer, which will update an existing customer record based on a unique key.

To call this API, you will need to make a POST call to the URL : https://{api url}/Leads

An example data packet is shown below. The only mandary field is the customers name

{ "APIkey": "jjhk765765jhjkhkhksssllkncsjGHHHJGsbsjsjllss83434772", "DealerID": "4", "Lead": { "LeadType": "Test Lead", "LeadSource": "Test Website", "Customer": { "CustomerURN": "67687ddddss", "CustomerType": "Retail", "Title": "Mr", "ForeName": "Bobby", "LastName": "Johnson", "Address": { "Address1": "1 Test Street", "Address2": "Test Area", "Address3": "Test Province", "Town": "Test Town", "County": "", "PostCode": "TE55 1AA" }, "Phone": "0113 111 2222", "Mobile": "0777 777 7777", "Email": "test@carro.systems", "Privacy": [ { "label": "Dealership Contact", "email": 1, "tel": 1, "sms": 1, "postal": 1, "marketing": 1 }, { "label": "Manufacturer Contact", "email": 0, "tel": 0, "sms": 0, "postal": 0, "marketing": 0 }, { "label": "Third-Party Contact", "email": 0, "tel": 0, "sms": 0, "postal": 0, "marketing": 0 } ], "Marketing": { "MethodOfContact": "Email", "SourceOfEnquiry": "Website Enquiry" } }, "Notes": "I would like to take a test dirve please in the car on your website", "EnquiryVehicle": { "NewUsed": "USED", "RegNo": "AF22XJE", "Make": "TESLA", "Model": "MODEL 3", "Derivative": "LONG RANGE AWD FACELIFT SALOON", "Fuel": "Electric", "Colour": "White", "ModelYear": "2022", "Transmission": "Auto", "Mileage": "12345", "InteriorTrim": "White Leather", "Price": "31999", "StockNo": "AS6667", "WebsiteURL": "" }, "TradeInVehicle": { "RegNo": "LN21ZNC", "Make": "Land Rover", "Model": "DEFENDER 90", "Derivative": "P300 HSE 6 SEATER WITH ULTIMATE STYLING 8 SPEED AUTO", "Fuel": "Diesel", "Colour": "Black", "ModelYear": "2021", "Transmission": "Auto", "Mileage": "56789", "InteriorTrim": "Black Cloth", "AskingPrice": "49000" } } }

Not all data fields are required. The example above shows a full data packet, but if you do not have those data fields available to pass in, just remove them from the structure or leave them blank.

A successful call will look like this :

{"message":"Added Successfully","code":100}