PushProspects

Pushes sales prospects (buyers). PushProspects is the first step of creating a deal.

Request Information

Parameters

Collection of ProspectPushRequest
NameDescriptionTypeAdditional information
DealKey

The API DealKey of an existing Prospect/Deal to update, or null/blank to create a new prospect. The Prospect and Deal records will have a same DealKey.

string

CustomerKey

Customer Key for this prospect.

string

StoreId

API identifier of the store for this prospect.

integer

Required

ExternalProspectId

Optional integrator identifier for this record. The ExternalProspectId is echoed in the push response, but isn't stored. When pushing multiple records in one request, it can be useful for matching push responses to push requests.

string

Identity

Buyer's contact information.

IdentityProfile

License

Buyer's driver's license number.

DriversLicense

SalesNumber

Employee numbers of the sales person.

string

ProspectSource

The way the prospect came into the store: walk-in, phone, internet, etc. To get the list of valid prospect sources for this store, call GetStoreSetups.

string

AdvertisingSource

The advertising channel that brought in the prospect. To get the list of valid advertising sources for this store, call GetStoreSetups.

string

PhysicalAddress

Physical address also known as garaging address.

Address

PhysicalDamageInsurance

Physical damage insurance (PDI).

PhysicalDamageInsurance

Sample Request

Response Information

Resource Description

Collection of StorePushResponse
NameDescriptionTypeAdditional information
StoreId

integer

PushedDeal

Deal

PushedRecordKey

string

PushResult

PushResult

Message

string

ExternalRecordId

string

Sample Response