Rollick Knowledge

Contact us

Lead Dealer Integration Status API


Overview

 Use the Lead Dealer Integration Status  API to create a record in the integration section that shows the integration and if it was successfully sent to the CRM provider on the lead detail page.

 Related APIs: 


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.
  • 500 (Internal Server Error). An unknown error occurred during the import


Authentication

The Lead Dealer Integration API requires authentication when hitting the Aimbase endpoint.  The HTTP POST will require a valid Authenticate message header with an API token. See the Aimbase Authentication Web Service Specification for more details on how to retrieve a valid API token. 

                                    Authenticate message header example

                                    Authenticate: Avala-Api {username}:{token}

If you are hitting the shared service end point, the Lead Dealer Integration API requires a Authentication - Bearer Token. 


Post Information

HTTP Endpoint 

Aimbase: 

  • https://{baseurl}/Marketing/api/LeadDealerIntegrationStatus

Shared Service: 

Data Schema 

Field Name 

Required 

Notes 

Description 

LeadUid

X 

 GUID

The lead record's GUID. 

DealerIntegrationTypeCode

X 


The code for the dealer's integration the lead is being sent to.
AimbaseInstance X String The CRM Service will pass values to this field for the end point in the Share Service. 

Status


Max Length: 256

 Success/failure response from the CRM provider.
ViewerName
Max Length: 256  User that viewed the lead in the CRM provider.

ViewedDate

 

 

 Date that the lead was viewed in the CRM provider.
Caller

 X

Max Length: 200

The source that is sending the lead to the CRM provider. 

AccountId

 X

Max Length: 200

Identifier used to route the lead to the dealer within the CRM provider. 

 


JSON Example Post

POST: https://sharedqa.aimbase.com/api/LeadDealerIntegrationStatus
Authenticate: Bearer timestamp="1670405582" ,nonce="SH5ov3RxxE8rsw1vdlkajrwgs"
Content-Type: application/json
 
{ 
    "LeadUid" : "99c932d0-310c-497b-8e45-cad143231092", 
    "AimbaseInstance" : "aimbase_rollick_qa, 
    "DealerIntegrationTypeCode" : "Lightspeed", 
    "Caller" : "SalesDriver", 
    "AccountId" : "99990032", 
    "Status" : "Assigned", 
    "ViewedDate" : "2022-12-07 T12:36:00Z", 
    "ViewerName" : "John Smith", 
   
} 

 

Related Articles