Overview

The Prospect OData API provides a way to retrieve and update prospect information. It has multiple filter and expand options, allowing you to get a list of prospects and all the information surrounding them. It will allow you to make an update to a prospect as well. 

To update search for or update a lead, see our Lead OData API.

This is an OData endpoint and it will support the OData query language. More information about this can be found at odata.org. 

Possible Response Codes

• 200 (OK). This request was successful and information will be returned.
• 204 (No Content). The patch was successful. 
• 400 (Bad Request). The request is invalid.
• 401 (Unauthorized). The token is missing, invalid, or expired.
• 404 (Not Found). The prospect was not able to be found.
• 500 (Internal Server Error). The request was malformed, the prospect given in the request did not exist, or some other unspecified error occurred when attempting to retrieve lead information.

Authentication

The Prospect OData API requires authentication. The GET and PATCH request will require a valid Authenticate message header with an API token. See the Aimbase Authentication API for more information on how to authenticate your request. 

Authenticate message header example:

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

Query Information

This OData API allows GET and PATCH. 

Endpoint for GET

GET https://{baseurl}/odata/V2/Prospects

Endpoint for PATCH

PATCH https://{baseurl}/odata/V2/Prospects

Prospect OData Data Schema 

The information below will be returned in a GET. It can also be updated via a PATCH. 

Expand Options 

The lead information is not included by default, but you can expand the prospect object to get lead information. When you expand, you will get additional fields related to the lead. If the prospect has multiple leads, they are returned in a collection under the Leads object.

The Prospect OData API also allows expansion for Manufacturer information. This will help in the case of multiple manufacturers per install.

Lead Fields on Expand

Manufacturer Fields on Expand

Sample Queries

Get First 10 Prospects

GET http://{baseurl}/odata/V2/Prospects?$top=10

Get a Prospect and Expand Leads

GET http://{baseurl}/odata/V2/Prospects(88048)?$expand=Leads

Patch Prospect's First Name

PATCH https://{baseurl}/odata/V2/Prospects(2)
Content-Type: application/json
Authenticate: Avala-Api {username}:{token}


{
  "FirstName": "Jane"
  "Customs": {
     "FieldName" : "FieldValue"
  }
}

Example Response (Expanded by Lead)

{
  "@odata.context": "https://{baseurl}/odata/V2/$metadata#Prospects/$entity",
  "Id": 88048,
  "ExternalId": null,
  "ProspectUid": "0ed74e8b-d33d-4ec1-a26f-7700c5ff4f37",
  "ProspectAggregationId": 87073,
  "CompanyId": null,
  "LastName": "Doe",
  "FirstName": "Jane",
  "Title": null,
  "Address1": "159 Jane Lane",
  "Address2": "",
  "City": "John",
  "State": "KY",
  "PostalCode": "40312     ",
  "ZIP4": null,
  "CompanyName": null,
  "CompanyTitle": null,
  "County": null,
  "Country": "United States",
  "HomePhone": "",
  "WorkPhone": "",
  "Fax": null,
  "Email": "jane.doe@rollick.io",
  "PhoneRefused": false,
  "TextRefused": false,
  "MailRefused": false,
  "FIPSCode": null,
  "CensusCode": null,
  "CassCertified": null,
  "CountryCode": "US",
  "MobilePhone": "",
  "AddrStatus": null,
  "AddrError": null,
  "LangCode": null,
  "CassOverride": null,
  "IsActive": true,
  "IsInvalidEmail": false,
  "IsAddressCleaned": false,
  "EmailRefused": false,
  "Score": 0,
  "ScoreText": "0",
  "LegacyCustomerId": 2886959,
  "OriginProspectType": "Website",
  "CurrentProspectType": "Website",
  "CompetitiveBrand": "",
  "Latitude": 37.839660,
  "Longitude": -83.936520,
  "IsNurtured": true,
  "HomePhoneNumeric": "",
  "WorkPhoneNumeric": "",
  "MobilePhoneNumeric": "",
  "CreateDate": "2016-11-22T00:14:23.327-06:00",
  "UpdateDate": null,
  "CreateAccountId": 0,
  "UpdateAccountId": null,
  "Customs": {},
  "Leads": [
    {
      "Id": 1,
      "ExternalId": "1484059",
      "LeadUid": "d3323958-56cc-4c01-9bfe-da7eeb41e096",
      "ProspectId": 88048,
      "DealerId": 1669,
      "ProductId": 6256,
      "LeadDate": "2016-09-27T09:49:32-05:00",
      "ViewedDate": null,
      "Event": null,
      "Score": 0,
      "CreateDate": "2016-11-22T00:14:41.47-06:00",
      "UpdateDate": "2020-12-23T10:41:00.177-06:00",
      "CreateAccountId": 0,
      "UpdateAccountId": 17690,
      "SentDate": "2016-09-27T09:51:16.623-05:00",
      "Medium": "Medium",
      "ScoreText": "0",
      "ProspectInterestId": 1,
      "IsActive": true,
      "StagingLeadId": null,
      "DealerDistance": null,
      "DealerDistanceMiles": null,
      "IsQualified": true,
      "FollowUpStatusCode": "Contacted",
      "PurchaseStatusCode": "Unknown",
      "LeadTypeCode": "LeadType",
      "LeadCategoryCode": "LeadCategory",
      "LeadSourceCode": "LeadSource",
      "LeadCampaignCode": null,
      "LeadStatusCode": "Pending",
      "Customs": {
        "BuyTimeFrame": null,
        "Comment": null
      },
      "Metadata": {}
    },
    {
      "Id": 111978,
      "ExternalId": "1484059",
      "LeadUid": "eef2deaf-6a7c-475e-bf1a-e1afcfbc5eeb",
      "ProspectId": 88048,
      "DealerId": 571,
      "ProductId": 6256,
      "LeadDate": "2016-09-27T09:49:32-05:00",
      "ViewedDate": null,
      "Event": null,
      "Score": 0,
      "CreateDate": "2016-11-22T00:14:41.47-06:00",
      "UpdateDate": null,
      "CreateAccountId": 0,
      "UpdateAccountId": null,
      "SentDate": "2016-09-27T09:51:16.8-05:00",
      "Medium": null,
      "ScoreText": "0",
      "ProspectInterestId": 1,
      "IsActive": true,
      "StagingLeadId": null,
      "DealerDistance": null,
      "DealerDistanceMiles": null,
      "IsQualified": true,
      "FollowUpStatusCode": "Contacted",
      "PurchaseStatusCode": "Unknown",
      "LeadTypeCode": "LeadType",
      "LeadCategoryCode": "LeadCategory",
      "LeadSourceCode": "LeadSource",
      "LeadCampaignCode": null,
      "LeadStatusCode": "Pending",
      "Customs": {
        "BuyTimeFrame": null,
        "Comment": null
      },
      "Metadata": {}
    }
  ]
}