PullProspects

Pulls sales prospects (buyers) matching a search.

Request Information

Parameters

Name	Description	Type	Additional information
PartialName		string
Phone		string
DriverLicenseNumber		string
StoreIds		Collection of integer	Required
MaxElapsedSinceUpdate	Filter records that have been created or modified between the difference of now and this PullRepairOrders Notice: The length of time allowed is limited to 32 days.	time interval
ChangedPeriodStart	Filter records that have been created or modified starting with this Note: ChangedPeriodStart is not used by PullRepairOrders	date
ChangedPeriodEnd	Filter records that have been created or modified ending with this Note: ChangedPeriodEnd is not used by PullRepairOrders	date
SuppressErrors	If an error occurs in a multi-dealer pull, continue pulling from other dealers instead of failing the whole request.	boolean

Sample Request

<ProspectSearchCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <ChangedPeriodEnd>2025-04-28T14:01:16.0372899Z</ChangedPeriodEnd>
  <ChangedPeriodStart>2025-04-28T14:01:16.0372899Z</ChangedPeriodStart>
  <MaxElapsedSinceUpdate>PT0.1234567S</MaxElapsedSinceUpdate>
  <SuppressErrors>true</SuppressErrors>
  <StoreIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </StoreIds>
  <DriverLicenseNumber>sample string 3</DriverLicenseNumber>
  <PartialName>sample string 1</PartialName>
  <Phone>sample string 2</Phone>
</ProspectSearchCriteria>

Response Information

Resource Description

Collection of Prospect

Name	Description	Type
DealKey		string
Attributes		IdentityProfile
References		ProspectReferences
DriverLicenseNumber		string
Upsource		string
ErrorMessage		string
PhysicalAddress	Physical address also known as garaging address.	Address
PhysicalDamageInsurance	Physical damage insurance (PDI).	PhysicalDamageInsurance
Placement		StorePlacement

Sample Response

<ArrayOfProspect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
  <Prospect>
    <Placement>
      <GroupId>8</GroupId>
      <GroupName>sample string 9</GroupName>
      <EnvironmentId>7</EnvironmentId>
      <EnvironmentType>Undefined</EnvironmentType>
      <DealerId>6</DealerId>
      <SourceId>5</SourceId>
      <CompanyId>3</CompanyId>
      <CompanyName>sample string 4</CompanyName>
      <StoreId>1</StoreId>
      <StoreName>sample string 2</StoreName>
    </Placement>
    <Attributes xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 3</d3p1:Address2>
      <d3p1:BirthDate>2025-04-28T14:01:16.0372899Z</d3p1:BirthDate>
      <d3p1:City>sample string 6</d3p1:City>
      <d3p1:CitySubDivisionName>sample string 20</d3p1:CitySubDivisionName>
      <d3p1:Country>sample string 16</d3p1:Country>
      <d3p1:County>sample string 14</d3p1:County>
      <d3p1:EmailAddress>sample string 12</d3p1:EmailAddress>
      <d3p1:PersonalName>
        <d3p1:FirstName>sample string 1</d3p1:FirstName>
        <d3p1:LastName>sample string 2</d3p1:LastName>
        <d3p1:MiddleName>sample string 3</d3p1:MiddleName>
        <d3p1:SingularName>sample string 4</d3p1:SingularName>
        <d3p1:Suffix>sample string 5</d3p1:Suffix>
        <d3p1:Title>None</d3p1:Title>
      </d3p1:PersonalName>
      <d3p1:PhoneNumbers>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
      </d3p1:PhoneNumbers>
      <d3p1:Sex>Unknown</d3p1:Sex>
      <d3p1:SpouseAddress1>sample string 2</d3p1:SpouseAddress1>
      <d3p1:SpouseAddress2>sample string 4</d3p1:SpouseAddress2>
      <d3p1:SpouseBirthDate>2025-04-28T14:01:16.0372899Z</d3p1:SpouseBirthDate>
      <d3p1:SpouseCity>sample string 9</d3p1:SpouseCity>
      <d3p1:SpouseCountry>sample string 17</d3p1:SpouseCountry>
      <d3p1:SpouseCounty>sample string 15</d3p1:SpouseCounty>
      <d3p1:SpouseEmailAddress>sample string 13</d3p1:SpouseEmailAddress>
      <d3p1:SpouseName>
        <d3p1:FirstName>sample string 1</d3p1:FirstName>
        <d3p1:LastName>sample string 2</d3p1:LastName>
        <d3p1:MiddleName>sample string 3</d3p1:MiddleName>
        <d3p1:SingularName>sample string 4</d3p1:SingularName>
        <d3p1:Suffix>sample string 5</d3p1:Suffix>
        <d3p1:Title>None</d3p1:Title>
      </d3p1:SpouseName>
      <d3p1:SpousePhoneNumbers>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
      </d3p1:SpousePhoneNumbers>
      <d3p1:SpouseSex>Unknown</d3p1:SpouseSex>
      <d3p1:SpouseSsn>sample string 19</d3p1:SpouseSsn>
      <d3p1:SpouseState>sample string 10</d3p1:SpouseState>
      <d3p1:SpouseZip>sample string 11</d3p1:SpouseZip>
      <d3p1:Ssn>sample string 18</d3p1:Ssn>
      <d3p1:State>sample string 7</d3p1:State>
      <d3p1:Title>sample string 5</d3p1:Title>
      <d3p1:Zip>sample string 8</d3p1:Zip>
    </Attributes>
    <DealKey>sample string 1</DealKey>
    <DriverLicenseNumber>sample string 2</DriverLicenseNumber>
    <ErrorMessage>sample string 4</ErrorMessage>
    <PhysicalAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 7</d3p1:Country>
      <d3p1:County>sample string 6</d3p1:County>
      <d3p1:Line1>sample string 1</d3p1:Line1>
      <d3p1:Line2>sample string 2</d3p1:Line2>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </PhysicalAddress>
    <PhysicalDamageInsurance xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:AgentAddress>sample string 7</d3p1:AgentAddress>
      <d3p1:AgentCSZ>sample string 8</d3p1:AgentCSZ>
      <d3p1:AgentCode>sample string 5</d3p1:AgentCode>
      <d3p1:AgentName>sample string 6</d3p1:AgentName>
      <d3p1:AgentPhone>sample string 9</d3p1:AgentPhone>
      <d3p1:PolicyCollision>
        <d3p1:Amount>1</d3p1:Amount>
        <d3p1:Currency>UsDollar</d3p1:Currency>
      </d3p1:PolicyCollision>
      <d3p1:PolicyComprehensiveDeductible>
        <d3p1:Amount>1</d3p1:Amount>
        <d3p1:Currency>UsDollar</d3p1:Currency>
      </d3p1:PolicyComprehensiveDeductible>
      <d3p1:PolicyEffectiveDate>2025-04-28T14:01:16.0372899Z</d3p1:PolicyEffectiveDate>
      <d3p1:PolicyExpirationDate>2025-04-28T14:01:16.0372899Z</d3p1:PolicyExpirationDate>
      <d3p1:PolicyNumber>sample string 10</d3p1:PolicyNumber>
      <d3p1:VendorAddress>sample string 3</d3p1:VendorAddress>
      <d3p1:VendorCSZ>sample string 4</d3p1:VendorCSZ>
      <d3p1:VendorCode>sample string 1</d3p1:VendorCode>
      <d3p1:VendorName>sample string 2</d3p1:VendorName>
    </PhysicalDamageInsurance>
    <References>
      <CustomerKey>sample string 1</CustomerKey>
    </References>
    <Upsource>sample string 3</Upsource>
  </Prospect>
  <Prospect>
    <Placement>
      <GroupId>8</GroupId>
      <GroupName>sample string 9</GroupName>
      <EnvironmentId>7</EnvironmentId>
      <EnvironmentType>Undefined</EnvironmentType>
      <DealerId>6</DealerId>
      <SourceId>5</SourceId>
      <CompanyId>3</CompanyId>
      <CompanyName>sample string 4</CompanyName>
      <StoreId>1</StoreId>
      <StoreName>sample string 2</StoreName>
    </Placement>
    <Attributes xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 3</d3p1:Address2>
      <d3p1:BirthDate>2025-04-28T14:01:16.0372899Z</d3p1:BirthDate>
      <d3p1:City>sample string 6</d3p1:City>
      <d3p1:CitySubDivisionName>sample string 20</d3p1:CitySubDivisionName>
      <d3p1:Country>sample string 16</d3p1:Country>
      <d3p1:County>sample string 14</d3p1:County>
      <d3p1:EmailAddress>sample string 12</d3p1:EmailAddress>
      <d3p1:PersonalName>
        <d3p1:FirstName>sample string 1</d3p1:FirstName>
        <d3p1:LastName>sample string 2</d3p1:LastName>
        <d3p1:MiddleName>sample string 3</d3p1:MiddleName>
        <d3p1:SingularName>sample string 4</d3p1:SingularName>
        <d3p1:Suffix>sample string 5</d3p1:Suffix>
        <d3p1:Title>None</d3p1:Title>
      </d3p1:PersonalName>
      <d3p1:PhoneNumbers>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
      </d3p1:PhoneNumbers>
      <d3p1:Sex>Unknown</d3p1:Sex>
      <d3p1:SpouseAddress1>sample string 2</d3p1:SpouseAddress1>
      <d3p1:SpouseAddress2>sample string 4</d3p1:SpouseAddress2>
      <d3p1:SpouseBirthDate>2025-04-28T14:01:16.0372899Z</d3p1:SpouseBirthDate>
      <d3p1:SpouseCity>sample string 9</d3p1:SpouseCity>
      <d3p1:SpouseCountry>sample string 17</d3p1:SpouseCountry>
      <d3p1:SpouseCounty>sample string 15</d3p1:SpouseCounty>
      <d3p1:SpouseEmailAddress>sample string 13</d3p1:SpouseEmailAddress>
      <d3p1:SpouseName>
        <d3p1:FirstName>sample string 1</d3p1:FirstName>
        <d3p1:LastName>sample string 2</d3p1:LastName>
        <d3p1:MiddleName>sample string 3</d3p1:MiddleName>
        <d3p1:SingularName>sample string 4</d3p1:SingularName>
        <d3p1:Suffix>sample string 5</d3p1:Suffix>
        <d3p1:Title>None</d3p1:Title>
      </d3p1:SpouseName>
      <d3p1:SpousePhoneNumbers>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
        <d3p1:PhoneNumber>
          <d3p1:Digits>sample string 1</d3p1:Digits>
          <d3p1:NumberType>Unknown</d3p1:NumberType>
        </d3p1:PhoneNumber>
      </d3p1:SpousePhoneNumbers>
      <d3p1:SpouseSex>Unknown</d3p1:SpouseSex>
      <d3p1:SpouseSsn>sample string 19</d3p1:SpouseSsn>
      <d3p1:SpouseState>sample string 10</d3p1:SpouseState>
      <d3p1:SpouseZip>sample string 11</d3p1:SpouseZip>
      <d3p1:Ssn>sample string 18</d3p1:Ssn>
      <d3p1:State>sample string 7</d3p1:State>
      <d3p1:Title>sample string 5</d3p1:Title>
      <d3p1:Zip>sample string 8</d3p1:Zip>
    </Attributes>
    <DealKey>sample string 1</DealKey>
    <DriverLicenseNumber>sample string 2</DriverLicenseNumber>
    <ErrorMessage>sample string 4</ErrorMessage>
    <PhysicalAddress xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 7</d3p1:Country>
      <d3p1:County>sample string 6</d3p1:County>
      <d3p1:Line1>sample string 1</d3p1:Line1>
      <d3p1:Line2>sample string 2</d3p1:Line2>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </PhysicalAddress>
    <PhysicalDamageInsurance xmlns:d3p1="http://schemas.datacontract.org/2004/07/DealerBuilt.Models">
      <d3p1:AgentAddress>sample string 7</d3p1:AgentAddress>
      <d3p1:AgentCSZ>sample string 8</d3p1:AgentCSZ>
      <d3p1:AgentCode>sample string 5</d3p1:AgentCode>
      <d3p1:AgentName>sample string 6</d3p1:AgentName>
      <d3p1:AgentPhone>sample string 9</d3p1:AgentPhone>
      <d3p1:PolicyCollision>
        <d3p1:Amount>1</d3p1:Amount>
        <d3p1:Currency>UsDollar</d3p1:Currency>
      </d3p1:PolicyCollision>
      <d3p1:PolicyComprehensiveDeductible>
        <d3p1:Amount>1</d3p1:Amount>
        <d3p1:Currency>UsDollar</d3p1:Currency>
      </d3p1:PolicyComprehensiveDeductible>
      <d3p1:PolicyEffectiveDate>2025-04-28T14:01:16.0372899Z</d3p1:PolicyEffectiveDate>
      <d3p1:PolicyExpirationDate>2025-04-28T14:01:16.0372899Z</d3p1:PolicyExpirationDate>
      <d3p1:PolicyNumber>sample string 10</d3p1:PolicyNumber>
      <d3p1:VendorAddress>sample string 3</d3p1:VendorAddress>
      <d3p1:VendorCSZ>sample string 4</d3p1:VendorCSZ>
      <d3p1:VendorCode>sample string 1</d3p1:VendorCode>
      <d3p1:VendorName>sample string 2</d3p1:VendorName>
    </PhysicalDamageInsurance>
    <References>
      <CustomerKey>sample string 1</CustomerKey>
    </References>
    <Upsource>sample string 3</Upsource>
  </Prospect>
</ArrayOfProspect>