Elead Sales Customers (Preview)

This API allows for the management of prospect/customer information inside the Elead CRM. This API includes the following capabilities and features for managing prospect/customer information, Add prospect/customer information such as name, phone numbers, email addresses and physical address and return the uniquely-assigned Elead ID on post, Update, search and retrieve prospect/customer contact information tied to an existing Elead ID.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name CDK Global
URL https://serviceconnect.support.cdk.com
Email mbd_support@cdk.com
Connector Metadata
Publisher CDK Global
Website https://fortellis.io
Privacy policy https://fortellis.io/privacy
Categories Data

What does this API do?

This API allows for the management of prospect/customer information inside the Elead CRM.

Intended Audience

This API is for dealers and vendor partners who need to manage prospect/customer data within the Elead CRM.

Capabilities and Features

This API includes the following capabilities and features for managing prospect/customer information.

  • Add prospect/customer information such as name, phone numbers, email addresses and physical address
  • Update prospect/customer contact information tied to an existing Elead ID
  • Retrieve prospects/customers by their Elead ID
  • Search prospects/customers by their name, email address, or phone number
  • Retrieve prospect/customer owned vehicles by their Elead ID

Pre-requisites

You will need the following to proceed

  • To use the connector, you need to be a Fortellis user
  • You need to create a solution in Fortellis to generate client id and secret to be used while calling the APIs

Detailed Documentation can be found at

https://apidocs.fortellis.io/specs/ba092364-accc-4ad9-865f-fac51c34cdb1

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Create a customer

Creates a prospect/customer

Get Customer by Id

Retrieves a prospect/customer record by Elead customer ID. An Elead customer ID is currently obtained as follows:

  • Create customer via POST /sales/v1/elead/customers

  • Search opportunities via GET /sales/v1/elead/opportunities/search

Get Vehicles by Id

Retrieves a prospect/customer vehicle record(s) by Elead customer ID. An Elead customer ID is currently obtained as follows:

  • Create customer via POST /sales/v1/elead/customers

  • Search opportunities via GET /sales/v1/elead/opportunities/search

Search customers

Search customers

Update a customer

Updates prospect/customer information

Create a customer

Creates a prospect/customer

Parameters

Name Key Required Type Description
Client Id
client_id True string

A client ID that should be unique to developer/solution provider building the solution.

Client Secret
client_secret True string

A client secret that should be unique to developer/solution provider building the solution.

Subscription Id
subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

isBusiness
isBusiness boolean

true/false whether this customer is a business

businessName
businessName string

Business name, set when isBusiness is true

businessContact
businessContact string

Name of the business contact person, set when isBusiness is true

title
title string

Customer's title

firstName
firstName string

Customer first name

middleName
middleName string

Customer middle name

lastName
lastName string

Customer last name

nickname
nickname string

Customer nickname

birthday
birthday date-time

Customer birthday

address
address True string

Customer Email address

emailType
emailType True string
doNotEmail
doNotEmail boolean

true/false to flag as Do Not Email

isPreferred
isPreferred boolean

true/false whether this is the customer's preferred email address

number
number True string

Phone number

phoneType
phoneType True string
preferredTimeToContact
preferredTimeToContact True string
doNotCall
doNotCall boolean

true/false to flag as Do Not Call

doNotText
doNotText boolean

true/false to flag as Do Not Text

preferCall
preferCall boolean

true/false whether the customer prefers to be contacted by phone

preferText
preferText boolean

true/false whether the customer prefers to be contacted by text

addressLine1
addressLine1 string

Customer address line 1

addressLine2
addressLine2 string

Customer address line 2

city
city string

Customer city

state
state string

Customer state

zip
zip True string

Customer postal code

country
country string

Customer country

county
county string

Customer county

doNotMail
doNotMail boolean

true/false to flag as Do Not Mail

isPreferred
isPreferred boolean

true/false whether this is the customer's preferred address

Returns

Body
Customer

Get Customer by Id

Retrieves a prospect/customer record by Elead customer ID. An Elead customer ID is currently obtained as follows:

  • Create customer via POST /sales/v1/elead/customers

  • Search opportunities via GET /sales/v1/elead/opportunities/search

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Format - uuid.

Client Id
client_id True string

A client ID that should be unique to developer/solution provider building the solution.

Client Secret
client_secret True string

A client secret that should be unique to developer/solution provider building the solution.

Subscription Id
subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

Returns

Body
Customer

Get Vehicles by Id

Retrieves a prospect/customer vehicle record(s) by Elead customer ID. An Elead customer ID is currently obtained as follows:

  • Create customer via POST /sales/v1/elead/customers

  • Search opportunities via GET /sales/v1/elead/opportunities/search

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Format - uuid.

Client Id
client_id True string

A client ID that should be unique to developer/solution provider building the solution.

Client Secret
client_secret True string

A client secret that should be unique to developer/solution provider building the solution.

Subscription Id
subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

Returns

Search customers

Search customers

Parameters

Name Key Required Type Description
Page
page integer

Format - int32.

Page Size
pageSize integer

Format - int32.

Client Id
client_id True string

A client ID that should be unique to developer/solution provider building the solution.

Client Secret
client_secret True string

A client secret that should be unique to developer/solution provider building the solution.

Subscription Id
subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

firstName
firstName string

Search string for the customer's first name

lastName
lastName string

Search string for the customer's last name

phoneNumber
phoneNumber string

Search string for the customer's phone number

emailAddress
emailAddress string

Search string for the customer's email address

Returns

Update a customer

Updates prospect/customer information

Parameters

Name Key Required Type Description
Customer Id
customerId True string

Format - uuid.

Client Id
client_id True string

A client ID that should be unique to developer/solution provider building the solution.

Client Secret
client_secret True string

A client secret that should be unique to developer/solution provider building the solution.

Subscription Id
subscription_id True string

A correlation ID that should be returned back to the caller to indicate the return of the given request.

Accept
Accept string

Accept Header

Accept-Charset
Accept-Charset string

Accept-Charset Header

Accept-Encoding
Accept-Encoding string

Accept-Encoding Header

Accept-Language
Accept-Language string

Accept-Language Header

If-Match
If-Match string

If-Match Header

If-None-Match
If-None-Match string

If-None-Match Header

Prefer
Prefer string

Preference of the customer

Request Id
Request-Id True string

Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request

isBusiness
isBusiness boolean

true/false whether this customer is a business

businessName
businessName string

Business name, set when isBusiness is true

businessContact
businessContact string

Name of the business contact person, set when isBusiness is true

title
title string

Customer's title

firstName
firstName string

Customer first name

middleName
middleName string

Customer middle name

lastName
lastName string

Customer last name

nickname
nickname string

Customer nickname

birthday
birthday date-time

Customer birthday

address
address True string

Customer Email address

emailType
emailType True string
doNotEmail
doNotEmail boolean

true/false to flag as Do Not Email

isPreferred
isPreferred boolean

true/false whether this is the customer's preferred email address

number
number True string

Phone number

phoneType
phoneType True string
preferredTimeToContact
preferredTimeToContact True string
doNotCall
doNotCall boolean

true/false to flag as Do Not Call

doNotText
doNotText boolean

true/false to flag as Do Not Text

preferCall
preferCall boolean

true/false whether the customer prefers to be contacted by phone

preferText
preferText boolean

true/false whether the customer prefers to be contacted by text

addressLine1
addressLine1 string

Customer address line 1

addressLine2
addressLine2 string

Customer address line 2

city
city string

Customer city

state
state string

Customer state

zip
zip True string

Customer postal code

country
country string

Customer country

county
county string

Customer county

doNotMail
doNotMail boolean

true/false to flag as Do Not Mail

isPreferred
isPreferred boolean

true/false whether this is the customer's preferred address

Returns

Body
Customer

Definitions

Customer

Name Path Type Description
id
id uuid

Unique customer identifier

isBusiness
isBusiness boolean

true/false whether this customer is a business

businessName
businessName string

Business name, set when isBusiness is true

businessContact
businessContact string

Name of the business contact person, set when isBusiness is true

title
title string

Customer's title

firstName
firstName string

Customer first name

middleName
middleName string

Customer middle name

lastName
lastName string

Customer last name

nickname
nickname string

Customer nickname

birthday
birthday date-time

Customer birthday

emails
emails array of CustomerEmail

Customer Email address(es)

phones
phones array of CustomerPhone

Customer phone number(s)

address
address CustomerAddress
links
links array of LinkDescriptionObject

A collection of HATEOAS links

CustomerEmail

Name Path Type Description
address
address string

Customer Email address

emailType
emailType string
doNotEmail
doNotEmail boolean

true/false to flag as Do Not Email

isPreferred
isPreferred boolean

true/false whether this is the customer's preferred email address

CustomerPhone

Name Path Type Description
number
number string

Phone number

phoneType
phoneType string
preferredTimeToContact
preferredTimeToContact string
doNotCall
doNotCall boolean

true/false to flag as Do Not Call

doNotText
doNotText boolean

true/false to flag as Do Not Text

preferCall
preferCall boolean

true/false whether the customer prefers to be contacted by phone

preferText
preferText boolean

true/false whether the customer prefers to be contacted by text

CustomerAddress

Name Path Type Description
addressLine1
addressLine1 string

Customer address line 1

addressLine2
addressLine2 string

Customer address line 2

city
city string

Customer city

state
state string

Customer state

zip
zip string

Customer postal code

country
country string

Customer country

county
county string

Customer county

doNotMail
doNotMail boolean

true/false to flag as Do Not Mail

isPreferred
isPreferred boolean

true/false whether this is the customer's preferred address

SearchCustomersResponse

Name Path Type Description
items
items array of SearchCustomer

A collection of customer search results

totalItems
totalItems integer

Total number of customers for the given search

totalPages
totalPages integer

Total number of pages of customers for the given search

pageNumber
pageNumber integer

Current page number for this set of paged results

pageSize
pageSize integer

Page size for this set of paged results

links
links array of LinkDescriptionObject

A collection of HATEOAS links

SearchCustomer

Name Path Type Description
id
id uuid

Unique identifier for this customer

firstName
firstName string

Customer first name

lastName
lastName string

Customer last name

emails
emails array of CustomerEmail

Customer Email Address(es)

phones
phones array of CustomerPhone

Customer phone number(s)

address
address CustomerAddress
rank
rank float

Relevancy ranking of this customer search result

CustomerVehicleCollection

Name Path Type Description
id
id uuid

Unique identifier for this vehicle

exteriorColor
exteriorColor string

Exterior color of the vehicle

interiorColor
interiorColor string

Interior color of the vehicle

mileage
mileage integer

Mileage of the vehicle

milesPerWeek
milesPerWeek integer

Average miles driven per week

year
year integer

Year of manufacture

make
make string

Brand of vehicle

model
model string

Name of the vehicle

trim
trim integer

Description of the trim

vin
vin string

Vehicle identification number

options
options CustomerVehicleOptions

Vehicle options

vehicleOwner
vehicleOwner CustomerVehicleOwner

Vehicle owner

CustomerVehicleOptions

Vehicle options

Name Path Type Description
fuelType
fuelType string

Type of fuel

interiorType
interiorType string

Type of interior

vehicleCondition
vehicleCondition string

Condition of vehicle

bodyStyle
bodyStyle string

Vehicle body style

engineDescription
engineDescription string

Type of engine

modelCode
modelCode string

Model code

numberOfCylinders
numberOfCylinders integer

Number of cylinders

numberOfDoors
numberOfDoors byte

Number of doors

transmission
transmission string

Type of transmission

isAutomaticTransmission
isAutomaticTransmission boolean

true/false whether the vehicle has an automatic transmission

hasAirBags
hasAirBags boolean

true/false whether the vehicle has air bags

hasCruiseControl
hasCruiseControl boolean

true/false whether the vehicle has cruise control

hasAirConditioning
hasAirConditioning boolean

true/false whether the vehicle has air conditioning

CustomerVehicleOwner

Vehicle owner

Name Path Type Description
isActive
isActive boolean

true/false whether the owner is active

customerId
customerId uuid

Unique identifier for the vehicle owner

vehicleId
vehicleId uuid

Unique identifier for the vehicle

LinkDescriptionObject

Name Path Type Description
href
href string

The target URI

rel
rel string

The link relation type

method
method string

The HTTP verb that MUST be used to make a request to the target of the link

title
title string

The title that describes the object