Connectors Reference
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.
|
Status: Preview |
Tier: Premium |
Version: 1.0 |
|
Name |
Summary |
|
Get Customer by Id |
|
|
Update a customer |
|
|
Get Vehicles by Id |
|
|
Create a customer |
|
|
Search customers |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Get Customer by Id
Description: 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
Syntax:
EleadSalesCustomers.Customers_GetCustomer (string customerId, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
customerId |
string (Customer Id) |
Format - uuid. |
True |
|
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
Accept |
string (Accept) |
Accept Header |
False |
|
|
Accept-Charset |
string (Accept-Charset) |
Accept-Charset Header |
False |
|
|
Accept-Encoding |
string (Accept-Encoding) |
Accept-Encoding Header |
False |
|
|
Accept-Language |
string (Accept-Language) |
Accept-Language Header |
False |
|
|
If-Match |
string (If-Match) |
If-Match Header |
False |
|
|
If-None-Match |
string (If-None-Match) |
If-None-Match Header |
False |
|
|
Prefer |
string (Prefer)Values: [return=representation, return=minimal] |
Preference of the customer |
False |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
True |
Returns:
Type:Customer
Summary: Update a customer
Description: Updates prospect/customer information
Syntax:
EleadSalesCustomers.Customers_UpdateCustomer (string customerId, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]CustomerRequest customerRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
customerId |
string (Customer Id) |
Format - uuid. |
True |
|
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
Accept |
string (Accept) |
Accept Header |
False |
|
|
Accept-Charset |
string (Accept-Charset) |
Accept-Charset Header |
False |
|
|
Accept-Encoding |
string (Accept-Encoding) |
Accept-Encoding Header |
False |
|
|
Accept-Language |
string (Accept-Language) |
Accept-Language Header |
False |
|
|
If-Match |
string (If-Match) |
If-Match Header |
False |
|
|
If-None-Match |
string (If-None-Match) |
If-None-Match Header |
False |
|
|
Prefer |
string (Prefer)Values: [return=representation, return=minimal] |
Preference of the customer |
False |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
True |
|
|
customerRequest |
|
|
False |
Returns:
Type:Customer
Summary: Get Vehicles by Id
Description: 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
Syntax:
EleadSalesCustomers.Customers_GetCustomerOwnedVehicles (string customerId, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
customerId |
string (Customer Id) |
Format - uuid. |
True |
|
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
Accept |
string (Accept) |
Accept Header |
False |
|
|
Accept-Charset |
string (Accept-Charset) |
Accept-Charset Header |
False |
|
|
Accept-Encoding |
string (Accept-Encoding) |
Accept-Encoding Header |
False |
|
|
Accept-Language |
string (Accept-Language) |
Accept-Language Header |
False |
|
|
If-Match |
string (If-Match) |
If-Match Header |
False |
|
|
If-None-Match |
string (If-None-Match) |
If-None-Match Header |
False |
|
|
Prefer |
string (Prefer)Values: [return=representation, return=minimal] |
Preference of the customer |
False |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
True |
Returns:
Type:CustomerVehicleCollection
Summary: Create a customer
Description: Creates a prospect/customer
Syntax:
EleadSalesCustomers.Customers_CreateCustomer (string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]CustomerRequest customerRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
Accept |
string (Accept) |
Accept Header |
False |
|
|
Accept-Charset |
string (Accept-Charset) |
Accept-Charset Header |
False |
|
|
Accept-Encoding |
string (Accept-Encoding) |
Accept-Encoding Header |
False |
|
|
Accept-Language |
string (Accept-Language) |
Accept-Language Header |
False |
|
|
If-Match |
string (If-Match) |
If-Match Header |
False |
|
|
If-None-Match |
string (If-None-Match) |
If-None-Match Header |
False |
|
|
Prefer |
string (Prefer)Values: [return=representation, return=minimal] |
Preference of the customer |
False |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
True |
|
|
customerRequest |
|
|
False |
Returns:
Type:Customer
Summary: Search customers
Description: Search customers
Syntax:
EleadSalesCustomers.Customers_SearchCustomers ([Optional]integer page, [Optional]integer pageSize, string client_id, string client_secret, string subscription_id, [Optional]string Accept, [Optional]string Accept-Charset, [Optional]string Accept-Encoding, [Optional]string Accept-Language, [Optional]string If-Match, [Optional]string If-None-Match, [Optional]string Prefer, string Request-Id, [Optional]SearchCustomersRequest searchCustomersRequest)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
page |
integer (Page) |
Format - int32. |
False |
|
|
pageSize |
integer (Page Size) |
Format - int32. |
False |
|
|
client_id |
string (Client Id) |
A client ID that should be unique to developer/solution provider building the solution. |
True |
|
|
client_secret |
string (Client Secret) |
A client secret that should be unique to developer/solution provider building the solution. |
True |
|
|
subscription_id |
string (Subscription Id) |
A correlation ID that should be returned back to the caller to indicate the return of the given request. |
True |
|
|
Accept |
string (Accept) |
Accept Header |
False |
|
|
Accept-Charset |
string (Accept-Charset) |
Accept-Charset Header |
False |
|
|
Accept-Encoding |
string (Accept-Encoding) |
Accept-Encoding Header |
False |
|
|
Accept-Language |
string (Accept-Language) |
Accept-Language Header |
False |
|
|
If-Match |
string (If-Match) |
If-Match Header |
False |
|
|
If-None-Match |
string (If-None-Match) |
If-None-Match Header |
False |
|
|
Prefer |
string (Prefer)Values: [return=representation, return=minimal] |
Preference of the customer |
False |
|
|
Request-Id |
string (Request Id) |
Format - guid. A correlation ID that should be returned back to the caller to indicate the return of the given request |
True |
|
|
searchCustomersRequest |
|
|
False |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Unique customer identifier |
|
isBusiness |
boolean
|
true/false whether this customer is a business |
|
businessName |
string
|
Business name, set when isBusiness is true |
|
businessContact |
string
|
Name of the business contact person, set when isBusiness is true |
|
title |
string
|
Customer's title Values: [Unspecified, Mr, Mrs, Ms, Dr, Sir, Miss, Rev, MrAndMrs, Admr, Capt, Cdr, Chief, Col, Gen, Judge, Lt, Sgt] |
|
firstName |
string
|
Customer first name |
|
middleName |
string
|
Customer middle name |
|
lastName |
string
|
Customer last name |
|
nickname |
string
|
Customer nickname |
|
birthday |
string(date-time)
|
Customer birthday |
|
emails |
array of (CustomerEmail)
|
Customer Email address(es) |
|
phones |
array of (CustomerPhone)
|
Customer phone number(s) |
|
address |
|
|
|
links |
array of (LinkDescriptionObject)
|
A collection of HATEOAS links |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
addressLine1 |
string
|
Customer address line 1 |
|
addressLine2 |
string
|
Customer address line 2 |
|
city |
string
|
Customer city |
|
state |
string
|
Customer state |
|
zip |
string
|
Customer postal code |
|
country |
string
|
Customer country |
|
county |
string
|
Customer county |
|
doNotMail |
boolean
|
true/false to flag as Do Not Mail |
|
isPreferred |
boolean
|
true/false whether this is the customer's preferred address |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
string
|
Customer Email address |
|
emailType |
string
|
Values: [Unknown, Personal, Work, Pager, Alternate] |
|
doNotEmail |
boolean
|
true/false to flag as Do Not Email |
|
isPreferred |
boolean
|
true/false whether this is the customer's preferred email address |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string
|
Phone number |
|
phoneType |
string
|
Values: [Unknown, Home, Cellular, Work] |
|
preferredTimeToContact |
string
|
Values: [Unspecified, Day, Evening] |
|
doNotCall |
boolean
|
true/false to flag as Do Not Call |
|
doNotText |
boolean
|
true/false to flag as Do Not Text |
|
preferCall |
boolean
|
true/false whether the customer prefers to be contacted by phone |
|
preferText |
boolean
|
true/false whether the customer prefers to be contacted by text |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
isBusiness |
boolean
|
true/false whether this customer is a business |
|
businessName |
string
|
Business name, set when isBusiness is true |
|
businessContact |
string
|
Name of the business contact person, set when isBusiness is true |
|
title |
string
|
Customer's title Values: [Unspecified, Mr, Mrs, Ms, Dr, Sir, Miss, Rev, MrAndMrs, Admr, Capt, Cdr, Chief, Col, Gen, Judge, Lt, Sgt] |
|
firstName |
string
|
Customer first name |
|
middleName |
string
|
Customer middle name |
|
lastName |
string
|
Customer last name |
|
nickname |
string
|
Customer nickname |
|
birthday |
string(date-time)
|
Customer birthday |
|
emails |
array of (CustomerEmail)
|
Customer Email address(es) |
|
phones |
array of (CustomerPhone)
|
Customer phone number(s) |
|
address |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Unique identifier for this vehicle |
|
exteriorColor |
string
|
Exterior color of the vehicle |
|
interiorColor |
string
|
Interior color of the vehicle |
|
mileage |
integer
|
Mileage of the vehicle |
|
milesPerWeek |
integer
|
Average miles driven per week |
|
year |
integer
|
Year of manufacture |
|
make |
string
|
Brand of vehicle |
|
model |
string
|
Name of the vehicle |
|
trim |
integer
|
Description of the trim |
|
vin |
string
|
Vehicle identification number |
|
options |
|
Vehicle options |
|
vehicleOwner |
|
Vehicle owner |
Summary:
Description: Vehicle options
Properties:
|
Name |
Type |
Summary |
|
fuelType |
string
|
Type of fuel |
|
interiorType |
string
|
Type of interior |
|
vehicleCondition |
string
|
Condition of vehicle |
|
bodyStyle |
string
|
Vehicle body style |
|
engineDescription |
string
|
Type of engine |
|
modelCode |
string
|
Model code |
|
numberOfCylinders |
integer
|
Number of cylinders |
|
numberOfDoors |
number(byte)
|
Number of doors |
|
transmission |
string
|
Type of transmission |
|
isAutomaticTransmission |
boolean
|
true/false whether the vehicle has an automatic transmission |
|
hasAirBags |
boolean
|
true/false whether the vehicle has air bags |
|
hasCruiseControl |
boolean
|
true/false whether the vehicle has cruise control |
|
hasAirConditioning |
boolean
|
true/false whether the vehicle has air conditioning |
Summary:
Description: Vehicle owner
Properties:
|
Name |
Type |
Summary |
|
isActive |
boolean
|
true/false whether the owner is active |
|
customerId |
string(uuid)
|
Unique identifier for the vehicle owner |
|
vehicleId |
string(uuid)
|
Unique identifier for the vehicle |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
href |
string
|
The target URI |
|
rel |
string
|
The link relation type |
|
method |
string
|
The HTTP verb that MUST be used to make a request to the target of the link |
|
title |
string
|
The title that describes the object |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
string(uuid)
|
Unique identifier for this customer |
|
firstName |
string
|
Customer first name |
|
lastName |
string
|
Customer last name |
|
emails |
array of (CustomerEmail)
|
Customer Email Address(es) |
|
phones |
array of (CustomerPhone)
|
Customer phone number(s) |
|
address |
|
|
|
rank |
number(float)
|
Relevancy ranking of this customer search result |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
firstName |
string
|
Search string for the customer's first name |
|
lastName |
string
|
Search string for the customer's last name |
|
phoneNumber |
string
|
Search string for the customer's phone number |
|
emailAddress |
string
|
Search string for the customer's email address |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
items |
array of (SearchCustomer)
|
A collection of customer search results |
|
totalItems |
integer(int32)
|
Total number of customers for the given search |
|
totalPages |
integer(int32)
|
Total number of pages of customers for the given search |
|
pageNumber |
integer(int32)
|
Current page number for this set of paged results |
|
pageSize |
integer(int32)
|
Page size for this set of paged results |
|
links |
array of (LinkDescriptionObject)
|
A collection of HATEOAS links |