Dealer Contact API

Overview

Use the Dealer Contact API to create contacts for a dealer within an OEM Aimbase. This end point will allow contacts to be created to receive Lead To, Lead CC notifications and many more. Dealer contacts can also be deactivated.  

 

 Authentication

This integration uses a bearer token. Please see the Authentication - Bearer Token for more details. 

 

Post Information

HTTP Endpoint 

 QA: https://crmintegrationqa.aimbase.net/api/DealerContact?source=[source value]

 Prod: https://crmintegration.aimbase.net/api/DealerContact?source=[source value]

This Dealer Contact endpoint does not adhere to a specific data model, and can accept key value pair strings in an JSON array format. Below, lists the required and recommended values to be passed. Rollick will need a list of expected fields and sample values to handle mapping to Rollick fields. Note that this endpoint only accepts lists. 

 

Values that need to be sent to the endpoint. 

Value Required  Format  Description 
Dealer Number

X 

  OEM's dealer number that is the dealer's identifier within Aimbase. 
Dealer Location     OEM's dealer location that is the dealer's identifier within Aimbase. 
FirstName     Contact's first name. 
LastName     Contact's last name. 
Email

X

  Contact's email. 
IsActive

X

Boolean true/false Indicate it the contact is active or not. 
CountryCode     Dealer contact's country code. Accepts two-digit ISO code values for the country. e.g. US, CA, FR, ES, ...  Required when sending emails to internal dealer contacts that are a part of a list.
ContactTypeNames    

Must send a contact type that exists in Aimbase. List is below. 

Marketing contact type codes:

  • Lead Emails To
  • Lead Emails CC
  • DailyUnopenedLeads
  • SegmentGeneral

Satisfaction contact type codes:

  • Upcoming Survey
  • Completed Survey
  • Perfect Score
  • Hot Alert

See Contact Types and Hierarchies for more available types. 

 

If no contact type is provided it will default to contact type of Lead To

 

Examples:

Single dealer contact. 

[
  {
    "DealerNumber": "DealerNumber_1",
    "FirstName": "John_1",
    "LastName": "Doe",
    "Email": "John_1@email.com",
    "IsActive": true,
    "CountryCode": "US"
  },
]

 

Multiple dealer contacts. 

[
  {
    "DealerNumber": "DealerNumber_1",
    "FirstName": "John_1",
    "LastName": "Doe",
    "Email": "John_1@email.com",
    "IsActive": true,
    "CountryCode": "US"
  },
  {
    "DealerNumber": "DealerNumber_2",
    "FirstName": "John_2",
    "LastName": "Doe",
    "Email": "John_2@email.com",
    "IsActive": true,
    "CountryCode": "US"
  },
  {
    "DealerNumber": "DealerNumber_3",
    "FirstName": "John_3",
    "LastName": "Doe",
    "Email": "John_3@email.com",
    "IsActive": true,
    "CountryCode": "US"
  },
  {
    "DealerNumber": "DealerNumber_3",
    "FirstName": "John_4",
    "LastName": "Doe",
    "Email": "John_4@email.com",
    "IsActive": true,
    "CountryCode": "US"
  }
]