Introduction
This document provides third parties specifications to send leads for OEM based programs (dealer nurture, lead scoring, lens view or Rollick concierge service). Once Rollick receives the lead, the lead will run through a series of validation steps to check for required field values, the source of the lead, etc. before the lead is qualifying for one of the Rollick dealer programs and accepted. It is preferred leads to be sent in real-time.
End Point
- https://crmintegrationqa.aimbase.net/api/CRMLeadCreate?source={CRMProvider}. QA endpoint.
- https://crmintegration.aimbase.net/api/CRMLeadCreate?source={CRMProvider}.Production endpoint.
Rollick will provide the CRMProvider value.
Possible Response Codes
- 201 (Created).This response indicates that the lead data was successfully parsed. The body of the response will contain the success or failure status for each lead that was submitted in the request. NOTE: The response record details for each lead will be returned in the order that they were submitted.
- 400 (Bad Request). Along with the 400 response, the body of the response will contain an error message describing why the request was a bad request.
- 401 (unauthorized). Token is missing or invalid.
- 500 (Internal Server Error). An unknown error occurred during the import
Authentication
This integration uses a bearer token. Please see the Authentication - Bearer Token for more details.
Data Schema
Include (but not limited to) the fields below as lead data points for retrieval.
| Field | Required | Format | Notes |
| LeadDate | X |
YYYY-MM-dd ±hh:mm | The date an individual submitted their lead information. |
| LeadCreatedDate | X |
YYYY-MM-dd ±hh:mm | The date the lead was created in the CRM system. |
| LeadSource | String | Origin of the lead i.e. dealer website, ect. | |
| LeadStatus | String | Indicates the buying cycle status of the lead i.e. working, sold, lost, abandoned. | |
| FirstName | X |
String |
The first name of the lead. |
| LastName | X |
String |
The last name of the lead. |
X |
String | The email of the lead. | |
| Address1 | String |
The primary address of the lead. | |
| Address2 | String |
The secondary address of the lead. |
|
| City | String |
The city of the lead. | |
| State | String. Max Length: 3 |
State code or Province code. | |
| PostalCode | X |
String. Max Length: 10 | The postal code of the lead. |
| CountryCode | X |
String. Max Length: 2 |
ISO two-letter country codes. |
| Phone | String | The lead's phone number. | |
| Manufacturer | String | Manufacturer identifier | |
| Make | X |
String | The make/brand of the lead's product. |
| Model | String | The model/product name of the lead's product. | |
| Year | String | The model year of the lead's product. | |
| Trim | String | The trim of the lead's product | |
| ProductClassification | String | Used to define a lead's product classification. | |
| ConditionCode | String | A code that identifies if the product is New (N), Used (U) or Showroom (S). This value will need to be dictated by Rollick pending the type of leads are being sent dealer/OEM. |
|
| VIN | String | The VIN of the lead's product | |
| DealerName | X | String | CRM's dealer name. |
| DealerIdentifier | X | String | CRM's internal identifier for a dealer. |
| TradeInMake | String | The make of the lead's trade-in. | |
| TradeInModel | String | The model of the lead's trade-in. |
|
| TradeInYear | String | The year of the lead's trade-in. |
|
| TradeInVIN | String |
The VIN of the lead's trade-in. |
|
| SystemInternalIdentifier | X |
String | CRM's internal identifier for lead record. |
| Customs | String | Use this object to pass additional data points. |
Example Post:
POST http://crmintegrationqa.aimbase.net/api/crmleadcreate?source={CRMProvider} Content-Type: application/json Authenticate: Bearer timestamp="{timestamp}",nonce="{nonce}",signature="{signature}",publickey="{publickey}" { "LeadDate":"2023-03-08T08:16:01.137", "LeadCreatedDate":"2023-03-08T08:16:48.217", "LeadSource":"CRM", "LeadStatus":"Viewed", "FirstName":"John", "LastName":"Doe", "Email":"John.Doe@gmail.com", "Address1":"123 Address 1", "Address2":"123 Address 2", "City":"Fenton", "State":"MO", "PostalCode":"63026", "CountryCode":"US", "Phone":"555-5555", "Manufacturer":"ROL", "Make":"Rollick", "Model":"Rollick", "Year":"2023", "Trim":"Rollick", "ProductClassification":"RV" "ConditionCode":"N", "VIN":"123456789", "DealerName":"Rollick Dealer", "DealerIdentifier":"12345", "TradeInMake":"Rollick", "TradeInModel":"Rollick", "TradeInYear":"2023", "TradeInVIN":"123456789", "SystemInternalIdentifier":"12345", "Customs": [ { "FieldName": "VehicleClass", "FieldValue": "ATV" } ]
Example Response Success:
{
"Status":"Sucess",
"StatusMessage":"Success processing lead",
"Messages":[]
}
Example Response Error:
{
"Status":"Error",
"StatusMessage":"Error processing lead",
"Messages":[
{
"Message":"CountryCode is a required field"
}
]
}