incoming_leads_api
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
incoming_leads_api [2016/02/18 19:54] david Update listing_days_on_market description |
incoming_leads_api [2016/05/27 21:09] igor [Property fields] |
||
|---|---|---|---|
| Line 121: | Line 121: | ||
| ^ Field name ^ Type ^ Presence ^ Description | | ^ Field name ^ Type ^ Presence ^ Description | | ||
| - | | ''type'' | string | required | TODO: document options | | + | | ''type'' | string | required | We have a list of [[http://docs.realgeeks.com/outgoing_leads_api_developers#type_values|all supported types]] | |
| | ''source'' | string | required | Name of your source, where activity is coming from | | | ''source'' | string | required | Name of your source, where activity is coming from | | ||
| | ''description'' | string | required | Human readable description | | | ''description'' | string | required | Human readable description | | ||
| | ''property'' | **Property** | optional | In case this activity was related to a specific property. If present it is a document with **Property** fields | | | ''property'' | **Property** | optional | In case this activity was related to a specific property. If present it is a document with **Property** fields | | ||
| | ''created'' | string | optional | When creating a lead this field is optional and if not provided will be set to the time the request was received. Format must be a combined date and time according to ISO 8601, ex.: ''"2015-04-01T08:41:51+00:00"'' | | | ''created'' | string | optional | When creating a lead this field is optional and if not provided will be set to the time the request was received. Format must be a combined date and time according to ISO 8601, ex.: ''"2015-04-01T08:41:51+00:00"'' | | ||
| - | |||
| ====== Property fields ====== | ====== Property fields ====== | ||
| Line 145: | Line 144: | ||
| | ''listing_status'' | string | optional | If the property is being sold this is the current status, any format is allowed. ex.: "For Sale" | | | ''listing_status'' | string | optional | If the property is being sold this is the current status, any format is allowed. ex.: "For Sale" | | ||
| | ''listing_days_on_market'' | integer | optional | If the property has pending date, the number of days between list date and pending date. If the property has no pending date, but has a closing date, the number of days between list date and closing date. If the property has no closing date, but has a list date, the number of days between list date and today. Otherwise, nothing| | | ''listing_days_on_market'' | integer | optional | If the property has pending date, the number of days between list date and pending date. If the property has no pending date, but has a closing date, the number of days between list date and closing date. If the property has no closing date, but has a list date, the number of days between list date and today. Otherwise, nothing| | ||
| + | | ''list_date'' | string | optional | When this property was listed for sale. Format must be a combined date and time according to ISO 8601, ex.: “2015-04-01T08:41:51+00:00” | | ||
| | ''estimated_value'' | string | optional | Estimated value this property could be sold for, useful for Seller or Potential Seller leads. Could be from an automated or personalized valuation. The supported format is a number with optional decimal places, ex.: "100500" or "100500.90" | | | ''estimated_value'' | string | optional | Estimated value this property could be sold for, useful for Seller or Potential Seller leads. Could be from an automated or personalized valuation. The supported format is a number with optional decimal places, ex.: "100500" or "100500.90" | | ||
| | ''last_sold_date'' | string | optional | Doesn't have any format requirement, could be something like ''"2015-12-25"'' | | | ''last_sold_date'' | string | optional | Doesn't have any format requirement, could be something like ''"2015-12-25"'' | | ||
| | ''last_sold_price'' | string | optional | If present will be a number with optional decimal places, ex.: "100500" or "100500.90" | | | ''last_sold_price'' | string | optional | If present will be a number with optional decimal places, ex.: "100500" or "100500.90" | | ||
| + | | ''rent_price'' | string | optional | Monthly rent price, used if this property is for rent | | ||
| | ''tags'' | []string| optional | Search tags, could be address components or any other field that destinations might use to easily implement a search feature. For Real Geeks websites we send things like street address, neighborhood, state, island, mls number, etc. i.e. ''["kailua", "212", "oahu", "981112"]'' | | | ''tags'' | []string| optional | Search tags, could be address components or any other field that destinations might use to easily implement a search feature. For Real Geeks websites we send things like street address, neighborhood, state, island, mls number, etc. i.e. ''["kailua", "212", "oahu", "981112"]'' | | ||
| | ''latitude'' | float | optional | | | | ''latitude'' | float | optional | | | ||
| | ''longitude'' | float | optional | | | | ''longitude'' | float | optional | | | ||
| - | + | | ''year_built'' | integer | optional | Year this property was built | | |
| ====== Example code ====== | ====== Example code ====== | ||
incoming_leads_api.txt · Last modified: 2016/07/06 21:37 by igor
Page Tools
