/lead/seller
- Mount Point: /rest/lead/seller
The following operations are supported on this resource:
POST
Post a new seller lead for agent bidding. Bidding for a "lead" is based on the sales commission or flat fee paid by the consumer.
If you're sending credit card information, please use "https" as the protocol in your request when invoking the API. IMPORTANT NOTICE: this API has been relocated to http://api.realtybaron.com/auctionParameters
| name | description | type | default |
|---|---|---|---|
| fname | The seller's first name | form | |
| lname | The seller's last name | form | |
| The seller's email address | form | ||
| daytime | The seller's daytime phone | form | |
| evening | The seller's evening phone | form | |
| property_type | The type of property -- single_family, multi_family, pud, manufactured_housing, condo, cooperative, mixed_use, raw_land or townhouse. | form | |
| address | The property's address | form | |
| zip | The property's ZIP code | form | |
| beds | The property's number of bedrooms | form | |
| baths | The property's number of bathrooms | form | |
| size | The property's total square feet | form | |
| estimate | The property's estimated value | form | |
| title | A title which identifies the lead opportunity, i.e. 3BR/2BA in Austin, TX | form | |
| description | any additional information relevant to the lead opportunity | form | |
| bid_format | Bidding format -- flat_fee or sales_commission | form | |
| bid_quantity | The number of bids the consumer will evaluate before choosing one as the winner. | form | 1 |
| opening_bid | Bidding will begin at this amount when the auction starts | form | |
| reserve_bid | The lead's contact information is withheld until a bid equal to this amount is received | form | |
| stop_bid | Bidding will be stopped when a bid equal to this amount is received | form | |
| min_rank | The minimum AgentRank™ controls which agents are eligible to submit bids -- 1, 2, 3...10 where 1 is the most inclusive and 10 is the most exclusive. | form | |
| referral_fee | The lead recipient pays you this amount in the event they are matched with the consumer. | form | |
| referral_format | The format of the referral fee -- flat_fee or sales_commission. A sales_commission indicates a percentage of sale paid at closing and can only be requested if you are licensed. | form | |
| origination_fee | The consumer pays you this amount in the event they are matched with an agent, i.e. $10. | form | |
| credit_type | The consumer's credit card type -- amex, discover, master, or visa | form | |
| credit_number | The number on the consumer's credit card | form | |
| credit_name | The name on the consumer's credit card | form | |
| credit_month | The expiration month of the consumer's credit card | form | |
| credit_year | The expiration year of the consumer's credit card | form | |
| credit_cvv2 | The verification code on the consumer's credit card | form | |
| credit_address_1 | The billing address (line 1) of the consumer's credit card | form | |
| credit_address_2 | The billing address (line 2) of the consumer's credit card | form | |
| credit_city | The billing city of the consumer's credit card | form | |
| credit_zip | The billing ZIP code of the consumer's credit card | form | |
| open_url | The location on your website where a pending auction can be opened for bidding. We'll replace the variable "{0}" with the auction's unique ID and embed the resulting URL in an email to the seller after the auction is created. For example, if you send us http://www.yourwebsite.com/auction/open?id={0}, we'll embed http://www.yourwebsite.com/auction/open?id=1 in an email to the seller. | form | |
| view_url | The location on your website where the auction can be viewed. We'll replace the variable "{0}" with the auction's unique ID and embed the resulting URL in an email to the seller after the auction opens for bidding. For example, if you send us http://www.yourwebsite.com/auction/view?id={0}, we'll embed http://www.yourwebsite.com/auction/view?id=1 in an email to the seller. | form | |
| qna_url | The location on your website where the seller can read and respond to an agent inquiry. We'll replace the variable {0} with the inquiry's unique ID and embed the resulting URL in an email to the seller after an agent submits the inquiry. For example, if you send us http://www.yourwebsite.com/auction/inquiry?id={0}, we'll embed http://www.yourwebsite.com/auction/inquiry?id=1 in an email to the seller. | form | |
| bid_url | The location on your website where the final bid can be viewed. We'll replace the variable {0} with the bid's unique ID and embed the resulting URL in an email to the seller after the auction is settled. For example, if you send us http://www.yourwebsite.com/auction/bid?id={0}, we'll embed http://www.yourwebsite.com/auction/bid?id=1 in an email to the seller. | form | |
| bids_url | The location on your website where candidate bids can be evaluated. We'll replace the variable {0} with the auction's unique ID and embed the resulting URL in an email to the buyer after the auction is closed. For example, if you send us http://www.yourwebsite.com/auction/bids?id={0}, we'll embed http://www.yourwebsite.com/auction/bids?id=1 in an email to the seller. | form | |
| redo_url | The location on your website where the buyer can "redo" a failed auction. We'll replace the variable {0} with the failed auction's unique ID and embed the resulting URL in an email to the seller after the failed auction has closed. For example, if you send us http://www.yourwebsite.com/auction/redo?id={0}, we'll embed http://www.yourwebsite.com/auction/redo?id=1 in an email to the seller. | form | |
| api_key | This identifies your application. Please email help@realtybaron.com to request an API key. | form |
Output Payload
| element | produceable content type(s) |
|---|---|
| response (XML) | |
| description | |
| api response | |