Introduction
This document provides guidance to develop an endpoint where Rollick can retrieve lead data for dealers that are participating in a Rollick dealer program that includes lead scoring, Lens, lead nurturing or the Rollick concierge service. Once Rollick retrieves lead data for a specified dealer, 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.
The Data Points and Design Specifications sections below provide details on the standard lead fields and endpoint capabilities required to retrieve lead data for a dealer participating in one of our programs.
Data Points
Include (but not limited to) the fields below as lead data points for retrieval.
| Field | Required | Notes |
| Lead Date | X |
The date an individual submitted their lead information. |
| Lead Created Date | X |
The date the lead was created in the CRM system. |
| Last Modified Date | X |
The date the lead record was last modified |
| Lead Source | Origin of the lead i.e. dealer website, ect. | |
| Lead Status | Indicates the buying cycle status of the lead i.e. working, sold, lost, abandoned. | |
| First Name | X |
|
| Last Name | X |
|
| Address 1 | ||
| Address 2 | ||
| City | ||
| State | State code. | |
| Postal Code | X |
|
| Country Code | X |
ISO two-letter country codes. |
| Phone | ||
| Make | X |
|
| Model | ||
| Year | ||
| Trim | ||
| Condition | ||
| VIN | ||
| Dealer Name | ||
| Dealer Identifier | CRM's internal identifier for a dealer. |
|
| Trade-In Make | ||
| Trade-In Model | ||
| Trade-In Year | ||
| Trade-In VIN | ||
| System Internal Identifier | X |
CRM's internal identifier for lead record. |
| Aimbase Identifier | X |
A lead sent byRollick to a CRM provider will include the Aimbase Identifier i.e. aimbase_rollick-12345 This value could be passed in a specific field or within the comment/notes field. |
Design Specifications
- Limited to a single API call to a single end point.
- Ability to retrieve lead data by (1) or more of the following criteria:
- By lead created date
- By system lead internal identifier
- By last modified date
- If there is a data hierarchy, Rollick would ideally retrieve the lowest level of lead information.
- For example, if a lead record matches to an existing customer, deal, or prospect, Rollick would like to retrieve the retrieve the original data points sent on the lead - not the aggregated details for the customer, deal or prospect.
- Rollick will need the following:
- Instructions on how to connect to the endpoint.
- List of potential result codes and definitions.
- Any system restrictions related to rate limiting.
- If there is an endpoint that can be used to send the Rollick Aimbase identifier and tag the lead that was retrieved.
- The format of date/time that will be passed - UTC, etc.