Overview

Use the Lead Disposition API to send activities (i.e email, call, note, appointment, quote) performed on a lead, or a lead status change (ie.assigned, viewed working, sold, etc). The activities and status changes will be add to the lead history section within Aimbase.

Prior to sending disposition, please provide list of activities and statuses that Rollick should expect. Rollick will handle mapping your values to the Rollick values listed below. This mapping must be completed prior to sending disposition to the qa or production endpoint. If there are any values that would fall outside of this mapping, we would still like to see examples to consider creating a new activity or status. 

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

Authentication is not required. Lead Disposition API uses a combination of CRM provider name and IP whitelisting to secure the end point.

Post Information

HTTP Endpoint

https://crmintegrationqa.aimbase.net/api/Disposition?source={CRM provider name}.  QA endpoint.

https://crmintegration.aimbase.net/api/Disposition?source={CRM provider name}.  Production endpoint.

Note, Rollick will provide the CRM provider name. 

Schema

JSON Example Post

{
   "ProspectActivity": {
      "EntryDate": "2021-09-11T11:45:00Z",
      "SourceProspectId": "aimbase_rollick_qa-42412",
      "PCHProspectId": "ABC123",
      "EntryType": "Contacted",
      "EntryDetail": "Assigned To:Johns Smith",
      "DealershipUser": "JohnD"
   }
}

XML Example Post

<?xml version="1.0" encoding="UTF-8"?>
<ProspectActivity>
<EntryDate>2021-09-11T11:45:00Z</EntryDate> 
<SourceProspectId>aimbase_rollick_qa-42412</SourceProspectId>  
   <PCHProspectId>ABC123</PCHProspectId>  
    <EntryType>Contacted</EntryType>
    <EntryDetail>Assigned To:Johns Smith</EntryDetail>
<DealershipUser>JohnD</DealershipUser>
</ProspectActivity>

Response

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 432
Content-Type: application/xml; charset=utf-8
Expires: -1
Server: Microsoft-IIS/10.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 21 Sep 2021 18:43:20 GMT
Connection: close


<ArrayOfDispositionResult 
  xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
  xmlns="http://schemas.datacontract.org/2004/07/Aimbase.Common.CRMIntegration.Web.Domain">
  <DispositionResult>
    <Response>Warning</Response>
    <ResultMessage>No corresponding Aimbase status mapping for EntryType: Opened, EntryDetail: , Aimbase Status: Viewed</ResultMessage>
    <Status>Data Processing Warning</Status>
  </DispositionResult>
</ArrayOfDispositionResult>