API: 
Lead Capture API
API Class: 
Lead Capture API
Description: 

This HTTP method will be used when the user intends to send a lead to the Lead Capture Service.

URL

Note: Ensure all testing is done in development environment prior to moving to production.

Environment URL
development https://api-st.cars.com/leadCaptureService/lead/REST/v1.0
production https://api.cars.com/leadCaptureService/lead/REST/v1.0

Request

Request Data Formats
Request type Header value
xml Content-type: text/xml
Request Parameters
Request Parameter Type Example value Description Required
leadTypeCode String INVTY_SRCH For private party leads, this value will always be "INVTY_SRCH" yes
affiliateProfileName String national Cars will supply this to you.  This value will be the same as your ftp login name. yes
leadEventRequestDate Date 2010-01-29-00:06 Timestamp from when the lead event occurred. Format: YYY-MM-DD-HH24:MM
personFirstName String abc The individual who filled the lead's first name. yes
personLastName String xyz The individual who filled the lead's last name. yes
emailAddress String wow@cars.com The individual who filled the lead's email address. yes
postalCode number 60193 The individual who filled the lead's 5 digit zipcode. yes
phone number number 3125895896 The individual who filled the lead's 5 digit phone number. Format: AREACODE+PREFIX+SUFFIX. No characters in between. yes
consumerIpAddress String 172.17.81.83 The individual who filled the lead's 5 IP address, if known. Otherwise, leave blank. no
comment String test 123 The individual who filled the lead's comments if applicable. no
nonDealerSeller     For a private party, please include this section with no values, just open and close. See Sample Request for an example. no
classifiedAdIdentifier number 69916777 Unique identifier for a Cars.com listing. yes
Request XML Example
<ld:inventoryLead xmlns:ld="http://api.cars.com/schemas/lead.xsd">
    <ld:event>
        <ld:leadTypeCode>INVTY_SRCH</ld:leadTypeCode>
        <ld:affiliateProfileName>national</ld:affiliateProfileName>
        <ld:leadEventRequestDate>2010-01-29-00:06</ld:leadEventRequestDate>
        <ld:consumer>
            <ld:name>
                <ld:personFirstName>abc</ld:personFirstName>
                <ld:personLastName>xyz</ld:personLastName>
            </ld:name>
            <ld:emailAddress>wow@cars.com</ld:emailAddress>
            <ld:streetAddress>
                <ld:postalCode>60193</ld:postalCode>
            </ld:streetAddress>
            <ld:phone>
                <ld:number>3125895896</ld:number>
                <ld:contactMethodType>PHNDAY</ld:contactMethodType>
            </ld:phone>
            <ld:consumerIpAddress>172.17.81.83</ld:consumerIpAddress>
            <ld:comment>test 123</ld:comment>
        </ld:consumer>
    </ld:event>
    <ld:seller>
        <ld:nonDealerSeller>
        </ld:nonDealerSeller>
    </ld:seller>
    <ld:vehicle>
        <ld:classifiedAdIdentifier>69916777</ld:classifiedAdIdentifier>
    </ld:vehicle>
</ld:inventoryLead>

Response

Response Data Formats
Response type Header value
xml Accept: application/xml
Response XML Example
<ld:inventoryLead xmlns:ld="http://api.cars.com/schemas/lead.xsd">
   <ld:event>
      <ld:leadEventIdentifier>3199731</ld:leadEventIdentifier>
      <ld:leadTypeCode>INVTY_SRCH</ld:leadTypeCode>
      <ld:classifiedAdIdentifier>6025427</ld:classifiedAdIdentifier>
      <ld:classifiedAdHistoryIdentifier>6539700</ld:classifiedAdHistoryIdentifier>
      <ld:informationPartnerRolePartyIdentifier>90688</ld:informationPartnerRolePartyIdentifier>
      <ld:informationPartnerRoleOrgName>Auto.com</ld:informationPartnerRoleOrgName>
      <ld:affiliateProfileName>autocom</ld:affiliateProfileName>
      <ld:leadEventRequestDate>2014-08-21T15:14:48.676-05:00</ld:leadEventRequestDate>
      <ld:consumer>
         <ld:name>
            <ld:personFirstName>Srdkkjavz</ld:personFirstName>
            <ld:personLastName>lead</ld:personLastName>
         </ld:name>
         <ld:emailAddress>ccsalesleads@gmail.com</ld:emailAddress>
         <ld:streetAddress>
            <ld:cityName>chicago</ld:cityName>
            <ld:stateProvinceCode>IL</ld:stateProvinceCode>
            <ld:postalCode>60093</ld:postalCode>
         </ld:streetAddress>
         <ld:phone>
            <ld:number>30367419</ld:number>
            <ld:contactMethodType>DAY</ld:contactMethodType>
         </ld:phone>
         <ld:deviceIdentifier/>
         <ld:consumerIpAddress>170.163.60.6</ld:consumerIpAddress>
         <ld:comment>Test in DQ01</ld:comment>
      </ld:consumer>
      <ld:userInputInstanceIdentifier>134988981712358840985495552583</ld:userInputInstanceIdentifier>
   </ld:event>
   <ld:seller>
      <ld:dealerSeller>
         <ld:sellerRolePartyIdentifier>26566</ld:sellerRolePartyIdentifier>
         <ld:sellerName>
            <ld:personFirstName>Boyer Ford</ld:personFirstName>
         </ld:sellerName>
         <ld:streetAddress>
            <ld:addressLine>2425 Broadway Street NE</ld:addressLine>
            <ld:cityName>Minneapolis</ld:cityName>
            <ld:stateProvinceCode>MN</ld:stateProvinceCode>
            <ld:postalCode>55413</ld:postalCode>
         </ld:streetAddress>
         <ld:geoLocation>
            <ld:addressLatitude>44.99</ld:addressLatitude>
            <ld:addressLongitude>-93.22</ld:addressLongitude>
         </ld:geoLocation>
         <ld:sellerPhone>
            <ld:number>8662036258</ld:number>
         </ld:sellerPhone>
         <ld:contactEmail>mjohnson@boyertrucks.com</ld:contactEmail>
         <ld:primaryPhone>
            <ld:number>8662036258</ld:number>
         </ld:primaryPhone>
         <ld:dealerMakeDescription>Saturn</ld:dealerMakeDescription>
         <ld:isUsedDealerSpecials>false</ld:isUsedDealerSpecials>
         <ld:isNewDealerSpecials>false</ld:isNewDealerSpecials>
         <ld:isUsedSearchInventory>true</ld:isUsedSearchInventory>
         <ld:isNewSearchInventory>true</ld:isNewSearchInventory>
         <ld:isSearchGroupInventory>false</ld:isSearchGroupInventory>
         <ld:isCPOShowroom>false</ld:isCPOShowroom>
         <ld:isShowMap>true</ld:isShowMap>
         <ld:refSourceId>199511</ld:refSourceId>
      </ld:dealerSeller>
   </ld:seller>
   <ld:vehicle>
      <ld:vehicleModelYear>2008</ld:vehicleModelYear>
      <ld:vehicleMakeDescription>Saturn</ld:vehicleMakeDescription>
      <ld:vehicleModelDescription>Astra</ld:vehicleModelDescription>
      <ld:vehicleTrimDescription>XR</ld:vehicleTrimDescription>
      <ld:vehicleBodystyleDescription>Hatchback</ld:vehicleBodystyleDescription>
      <ld:vehicleEngineDescription>1.8L I4 16V MPFI DOHC</ld:vehicleEngineDescription>
      <ld:vehicleTransmissionDescription>4-Speed Automatic</ld:vehicleTransmissionDescription>
      <ld:vehicleExteriorColorDescription>Salsa Red</ld:vehicleExteriorColorDescription>
      <ld:vehicleIdentifiers>
         <ld:makeIdentifier>43</ld:makeIdentifier>
         <ld:modelIdentifier>8818</ld:modelIdentifier>
         <ld:trimIdentifier>12803</ld:trimIdentifier>
         <ld:bodyStyleIdentifier>5</ld:bodyStyleIdentifier>
         <ld:modelYearIdentifier>2008</ld:modelYearIdentifier>
      </ld:vehicleIdentifiers>
      <ld:classifiedAdIdentifier>602645427</ld:classifiedAdIdentifier>
      <ld:classifiedAdHistoryIdentifier>653912700</ld:classifiedAdHistoryIdentifier>
      <ld:inventoryInterface>
         <ld:interfaceTypeCode>CLA</ld:interfaceTypeCode>
         <ld:interfaceTypeDescription>Core Listing Attributes</ld:interfaceTypeDescription>
         <ld:interfaceDefinitionCode>DMI</ld:interfaceDefinitionCode>
         <ld:interfaceDefinitionDescription>Digital Motorworks (DMi)</ld:interfaceDefinitionDescription>
      </ld:inventoryInterface>
      <ld:vehicleListPrice>9522</ld:vehicleListPrice>
      <ld:vehicleMileage>30235</ld:vehicleMileage>
      <ld:vehicleDoorCount>2</ld:vehicleDoorCount>
      <ld:vehicleStockType>U</ld:vehicleStockType>
      <ld:vehicleStockNumber>140496A</ld:vehicleStockNumber>
      <ld:vehicleIdentificationNumber>W08AT271085134228</ld:vehicleIdentificationNumber>
      <ld:vehicleDriveTrainDescription>FWD</ld:vehicleDriveTrainDescription>
      <ld:vehicleOptionalFeatureSet>Front Wheel Drive, Aluminum Wheels, Tires - Front Performance, Tires - Rear Performance, Temporary Spare Tire, Automatic Headlights, Fog Lamps, Heated Mirrors, Power Mirror(S), Intermittent Wipers, Variable Speed Intermittent Wipers, Rain Sensing Wipers, CD Player, Bucket Seats, Driver Adjustable Lumbar,, Rear Head Air Bag</ld:vehicleOptionalFeatureSet>
      <ld:sourceVehicleTrimDescripton>XR</ld:sourceVehicleTrimDescripton>
      <ld:isVehicleHistoryOneOwner>false</ld:isVehicleHistoryOneOwner>
      <ld:isAdBestOffer>false</ld:isAdBestOffer>
      <ld:isStockMedia>true</ld:isStockMedia>
      <ld:vehicleStandardFeatureSet>Remote power door locks, Power windows, Cruise control, 4-wheel ABS Brakes, Front Ventilated disc brakes, 1st and 2nd row curtain head airbags, Passenger Airbag, Side airbag, Audio system security, In-Dash single CD player, MP3 player, AM/FM stereo, Radio Data System, Speed Sensitive Audio Volume Control, Max cargo capacity: 45 cu.ft., Vehicle Emissions: ULEV II, Fuel Type: Regular unleaded, Fuel Capacity: 12.0 gal.,Rain sensing front wipers, Variable intermittent front wipers,</ld:vehicleStandardFeatureSet>
      <ld:vehicleWheelBase>103</ld:vehicleWheelBase>
      <ld:stockPhotoMediaURI>|B|242585.jpg</ld:stockPhotoMediaURI>
   </ld:vehicle>
   <ld:ext>
      <ld:extensionItem>
         <ld:key>isMicrosite</ld:key>
         <ld:value>false</ld:value>
      </ld:extensionItem>
      <ld:extensionItem>
         <ld:key>leadFilterGroup</ld:key>
         <ld:value>DEALER</ld:value>
      </ld:extensionItem>
      <ld:extensionItem>
         <ld:key>errorUrl</ld:key>
         <ld:value>/go/leads/inventory/leadThanks.jsp</ld:value>
      </ld:extensionItem>
      <ld:extensionItem>
         <ld:key>scsession</ld:key>
         <ld:value>EOIIxAQJ-vcYruUcd4R4M9X</ld:value>
      </ld:extensionItem>
      <ld:extensionItem>
         <ld:key>wssTabName</ld:key>
         <ld:value>summary|Dealer</ld:value>
      </ld:extensionItem>
      <ld:extensionItem>
         <ld:key>typType</ld:key>
         <ld:value>used</ld:value>
      </ld:extensionItem>
      <ld:extensionItem>
         <ld:key>srpURL</ld:key>
         <ld:value><![CDATA[prMx=9000&sf1Dir=DESC&prMn=0&mkId=20019&stkTyp=U&mdId=21179&rd=75&crSrtFlds=stkTypId-feedSegId-mkId-mdId-pseudoPrice&zc=06401&rn=0&PMmt=1-1-0&stkTypId=28881&sf2Dir=ASC&sf1Nm=price&sf2Nm=miles&isDealerGrouping=false&rpp=50&feedSegId=28705]]></ld:value>
      </ld:extensionItem>
      <ld:extensionItem>
         <ld:key>listingSource</ld:key>
         <ld:value>Digital Motorworks (DMi)</ld:value>
      </ld:extensionItem>
      <ld:extensionItem>
         <ld:key>leadSubmissionServerTime</ld:key>
         <ld:value>1408652088901</ld:value>
      </ld:extensionItem>
   </ld:ext>
</ld:inventoryLead>
Test
Method Type: 
POST
Endpoint URI: 
https://api-st.cars.com/leadCaptureService/lead/REST/v1.0