CRM Provider Disposition Retrieval Service Guidelines

Introduction

This document outlines guidance for developing an endpoint that enables Rollick to retrieve lead disposition data. Once a disposition record is retrieved, Rollick will map it to one of the lead statuses or lead activities listed below.

  • Activities
    • Email
    • Call
    • Text
    • Note
    • Appointment
    • Quote
  • Status: 
    • Viewed
    • Assigned 
    • Working
    • Sold
    • Lost
    • Abandoned

 

The Data Points and Design Specifications sections below provide details on the standard fields and endpoint capabilities required to retrieve lead disposition data for a participating dealer.

Data Points

Below are the data points we would need to retrieve. 

Field Notes
Create Date Date activity or status changed.
Activity/Status Change Action performed by dealer.
Lead Identifier This can be the Rollick Aimbase identifier or provider's identifier.
Dealer Identifier Dealer's unique identifier in provider's system. 

 

Design Specifications 

  • Ability to retrieve lead disposition data by (1) or more of the following criteria: 
    • By Date Create
    • By Dealer Identifier
  • Matching lead disposition back to a lead in Rollick: 
    • Retrieved lead disposition data must include Rollick’s Aimbase identifier (e.g., aimbase_rollick-123456). This identifier is provided when Rollick sends the lead to a provider.
    • Alternatively, the data must include a unique lead identifier that Rollick can use to match the disposition back to the original lead. This identifier is typically returned to Rollick in the API response after the lead is submitted.
  • 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.
    • The format of date/time - UTC, etc.