Lead Post Callback

Lead Post Callback

Lead Delivery HTTP POST Callback

In certain cases, a lead posting API is needed instead of sending email leads. HotPads offers an HTTP POST callback with a standard set of parameters:

field name notes example
listingId* your listing id in the feed listingId=p01023
name name of the inquirer name=Rachel
email* email id of the inquirer email=rachel@gmail.com
phone phone number of the inquirer phone=555-555-8378
movingDate YYYYMMDD movingDate=20160926
numBedroomsSought 0,1,2,3 etc. where 0=studio numBedroomsSought=3
numBathroomsSought 1,2,3 etc. numBathroomsSought=2
message message message=Looking for spacious 3 bedroom apartment or house
listingStreet street address of your listing listingStreet=Hayward Park Avenue
listingUnit unit# of your listing(if applicable) listingUnit=C102
listingCity city of your listing listingCity=Sunnyvale 
listingPostalCode postal code of your listing  listingPostalCode=94086
listingState  state of your listing  listingState=CA
listingContactEmail  email address the lead would be sent to, if it weren't being posted via this api listingContactEmail=propertymanager@HaywardParkApartments.com
neighborhoods  list of neighborhoods that inquirer is interested in neighborhoods=["Park Merced", "Sunset"]
propertyTypesDesired property types interested in  propertyTypesDesired=["apartment", "house", "townhouse"]
leaseLengthMonths lease duration leaseLengthMonths=12
introduction introduction message about the inquirer introduction=Hello my name is Rachel
smoker  boolean: true or false smoker=false
parkingTypeDesired parking type preferences  parkingTypeDesired=required
incomeYearly yearly income in US dollars incomeYearly=150000
creditScoreRangeJson credit score  creditScoreRangeJson={"creditScoreMin":675,"creditScoreMax":690}
movingFromCity moving from city movingFromCity=San Francisco
movingFromState moving from state movingFromState=California
moveInTimeframe move in timeframe  moveInTimeframe=asap
reasonForMoving reason for moving reasonForMoving=high rent
employmentStatus employment status employmentStatus=employed
jobTitle job title jobTitle=Software Engineer
employer employer employer=Zillow
employmentStartDate employment start date YYYY-MM-DD employmentStartDate=2015-09-27
employmentDetailsJson previous employment details  employmentDetailsJson=[{"jobTitle":"Software
Engineer","employer":"Google","startDate":"2012-07-21","endDate":"2015-09-20"}]
petDetailsJson pet details  petDetailsJson=[{"type":"dog","breed":"Lab","size":"huge","weightPounds":50,"description":"Really awesome lab"},{"type":"cat","size":"small","description":"Really annoying cat"}]

 

Most fields will usually be filled out, but only listingId and email will always be present. Your server should return standard http codes, 200 if accepted or 5xx depending on error response.

When you've implemented a handler for these requests, let us know its URL and we will route your leads accordingly. You may contact us by sending an email to rentalfeeds@zillow.com

Example POST 

POST /request HTTP/1.1
content-type: application/x-www-form-urlencoded; charset=UTF-8
host: hotpads.com
content-length: 277
listingId=p01023&name=Rachel&email=rachel%40gmail.com&phone=555-555-8378&movingDate=20160926&numBedroomsSought=3&numBathroomsSought=2&message=Looking%for%spacious%3%bedroom%apartment%or%house&listingStreet=Hayward%Park%Avenue&listingUnit=C102&listingCity=Sunnyvale&listingState=CA&listingContactEmail=propertymanager%40HaywardParkApartments.com&neighborhoods=%5B%22Park%20Merced%22%2C%20%22Sunset%22%5D&propertyTypesDesired=%5B%22apartment%22%2C%20%22house%22%2C%20%22townhouse%22%5D&leaseLengthMonths=12&introduction=Hello%my%name%is%Rachel&smoker=false&parkingTypeDesired=required&incomeYearly=150000&creditScoreRangeJson=%7B%22creditScoreMin%22%3A675%2C%22creditScoreMax%22%3A690%7D&movingFromCity=San%Francisco&movingFromState=California&moveInTimeframe=asap&reasonForMoving=high%rent&employmentStatus=employed&jobTitle=Software%Engineer&employer=Zillow&employmentStartDate=2015-09-27&employmentDetailsJson=%5B%7B%22jobTitle%22%3A%22Software%20Engineer%22%2C%22employer%22%3A%22Google%22%2C%22startDate%22%3A%222012-07-21%22%2C%22endDate%22%3A%222015-09-20%22%7D%5D&petDetailsJson=%5B%7B%22type%22%3A%22dog%22%2C%22breed%22%3A%22Lab%22%2C%22size%22%3A%22huge%22%2C%22weightPounds%22%3A50%2C%22description%22%3A%22Really%20awesome%20lab%22%7D%2C%7B%22type%22%3A%22cat%22%2C%22size%22%3A%22small%22%2C%22description%22%3A%22Really%20annoying%20cat%22%7D%5D