PushCustomers
Pushes customers, typically for service. See PushProspects for sales.
Request Information
Parameters
Collection of
CustomerPushRequest
Name | Description | Type | Additional information |
SourceId |
|
integer
|
Required
|
CustomerKey |
|
string
|
|
UserStoreId |
|
integer
|
Required
|
ExternalCustomerId |
|
string
|
|
SpouseName |
|
string
|
|
Identity |
|
IdentityProfile
|
Required
|
AllowsPhoneContact |
|
boolean
|
|
AllowsMailContact |
|
boolean
|
|
AllowsEmailContact |
|
boolean
|
|
AllowsSmsContact |
|
boolean
|
|
Comments |
|
string
|
|
IsWholesale |
|
boolean
|
|
Sample Request
<ArrayOfCustomerPushRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
<CustomerPushRequest>
<AllowsEmailContact>true</AllowsEmailContact>
<AllowsMailContact>true</AllowsMailContact>
<AllowsPhoneContact>true</AllowsPhoneContact>
<AllowsSmsContact>true</AllowsSmsContact>
<Comments>sample string 7</Comments>
<CustomerKey>sample string 2</CustomerKey>
<ExternalCustomerId>sample string 5</ExternalCustomerId>
<Identity 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-28T13:35:16.2528527Z</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-28T13:35:16.2528527Z</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>
</Identity>
<IsWholesale>true</IsWholesale>
<SourceId>1</SourceId>
<SpouseName>sample string 6</SpouseName>
<UserStoreId>4</UserStoreId>
</CustomerPushRequest>
<CustomerPushRequest>
<AllowsEmailContact>true</AllowsEmailContact>
<AllowsMailContact>true</AllowsMailContact>
<AllowsPhoneContact>true</AllowsPhoneContact>
<AllowsSmsContact>true</AllowsSmsContact>
<Comments>sample string 7</Comments>
<CustomerKey>sample string 2</CustomerKey>
<ExternalCustomerId>sample string 5</ExternalCustomerId>
<Identity 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-28T13:35:16.2528527Z</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-28T13:35:16.2528527Z</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>
</Identity>
<IsWholesale>true</IsWholesale>
<SourceId>1</SourceId>
<SpouseName>sample string 6</SpouseName>
<UserStoreId>4</UserStoreId>
</CustomerPushRequest>
</ArrayOfCustomerPushRequest>
Response Information
Resource Description
Collection of
SourcePushResponse
Name | Description | Type | Additional information |
SourceId |
|
integer
|
|
PushedRecordKey |
|
string
|
|
PushResult |
|
PushResult
|
|
Message |
|
string
|
|
ExternalRecordId |
|
string
|
|
Sample Response
<ArrayOfSourcePushResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
<SourcePushResponse>
<ExternalRecordId>sample string 4</ExternalRecordId>
<Message>sample string 3</Message>
<PushResult>Unprocessed</PushResult>
<PushedRecordKey>sample string 2</PushedRecordKey>
<SourceId>1</SourceId>
</SourcePushResponse>
<SourcePushResponse>
<ExternalRecordId>sample string 4</ExternalRecordId>
<Message>sample string 3</Message>
<PushResult>Unprocessed</PushResult>
<PushedRecordKey>sample string 2</PushedRecordKey>
<SourceId>1</SourceId>
</SourcePushResponse>
</ArrayOfSourcePushResponse>