Skip to main content

Create Real Estate

The real estate API of app.neoagent.co provides functionality to create a new real estate chatbot by sending a POST request to the endpoint /chat/Chatbot/RealEstateCreate.

Endpoint​

Request URL: https://app.neoagent.co/chat/Chatbot/RealEstateCreate
Method: POST

Required Headers​

The API request must include the following headers:

  • Authorization: <Your-Secret-Key> - string, required - The secret key to authenticate the API request
  • Content-Type: application/json - string, required - The content type of the request payload (must be application/json)

Request Body​

The request body must contain the following parameters:

{
// string, required - Chatbot ID (available in chatbot settings -> general -> chatbot ID)
"SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// string, required - Must be one of: [for_sale, for_rent]
"SaleType": "for_sale",
// string, required - Must be one of: [Active, PreOnMarket, Sold]
"Status": "Active",
// string, required - Currency symbol (e.g., $)
"CurrencySymbol": "$",
// string, required - Property type (e.g., Single Family Residential)
"PropertyType": "Single Family Residential",
// number, required - Number of bedrooms
"Bedrooms": 3,
// number, required - Number of bathrooms
"Bathrooms": 2.5,
// string, required - Property listing URL
"Url": "https://example.com/property/123",
// string, required - MLS number
"MLSNumber": "MLS123456",
// number, required - Year the property was built
"YearBuilt": 1998,
// number, required - Number of days on the market
"DaysOnMarket": 2,
// number, required - Lot area
"LotArea": 800,
// number, required - Building area
"BuildingArea": 2500,
// string, required - Must be one of: [Square Feet, Square Meters]
"AreaUnit": "Square Feet",
// array - Array of image URLs
"Images": [
"https://example.com/img1.jpg",
"https://example.com/img2.jpg"
],
// string - Must be one of: [OpenHouse, 3D]
"Tour": "OpenHouse",
// number, required - Number of parking spots
"ParkingSpots": 8,
// string - Property description
"Description": "Beautiful family home with modern comforts",
// array - Additional property information in the format [{'Key': 'xx', 'value': 'xx'}]
"ExtensionColumn": [
{
"Key": "Pool",
"value": "Yes"
},
{
"Key": "Garage",
"value": "2 cars"
}
],
// string - Description of the property location
"Location": "Residential area",
// string - Address
"Address": "123 Main St",
// string - City name
"City": "Los Angeles",
// string - State name
"State": "CA",
// string - ZIP code
"ZIP": "90001",
// number - Latitude of the property
"Latitude": 30.96,
// number - Longitude of the property
"Longitude": -78.93,
// number - Sale price
"SalePrice": 100000,
// number - Price per unit area
"UnitAreaPrice": 100,
// number - Monthly HOA fee
"HOAMonth": 500,
// number - Estimated price
"ZestimatePrice": 100000,
// number - Monthly rent price
"RentPrice": 2500,
// string - Must be one of: [Entire space, Room]
"SpaceType": "Entire space",
// number - Deposit amount required
"DepositFee": 5000
}

Parameters​

  • SerialNumber - string, required - Chatbot ID (available in chatbot settings -> general -> chatbot ID)
  • SaleType - string, required - Must be one of: [for_sale, for_rent]
  • Status - string, required - Must be one of: [Active, PreOnMarket, Sold]
  • CurrencySymbol - string, required - Currency symbol (e.g., $)
  • PropertyType - string, required - Property type (e.g., Single Family Residential)
  • Bedrooms - number, required - Number of bedrooms
  • Bathrooms - number, required - Number of bathrooms
  • Url - string, required - URL of the property listing
  • MLSNumber - string, required - MLS number
  • YearBuilt - number, required - Year the property was built
  • DaysOnMarket - number, required - Number of days on the market
  • LotArea - number, required - Lot area
  • BuildingArea - number, required - Building area
  • AreaUnit - string, required - Must be one of: [Square Feet, Square Meters]
  • Images - array - Array of image URLs
  • Tours - string - Must be one of: [OpenHouse, 3D]
  • ParkingSpots - number, required - Number of parking spots
  • Description - string - Property description
  • ExtensionColumn - array - Additional property information in the format [{'Key': 'xx', 'value': 'xx'}]
  • Location - string - Description of the property location
  • Address - string - Address
  • City - string - City name
  • State - string - State name
  • ZIP - string - ZIP code
  • Latitude - number - Latitude of the property
  • Longitude - number - Longitude of the property
  • SalePrice - number - Sale price
  • UnitAreaPrice - number - Price per unit area
  • HOAMonth - number - Monthly HOA fee
  • ZestimatePrice - number - Estimated price
  • RentPrice - number - Monthly rent price
  • SpaceType - string - Must be one of: [Entire space, Room]
  • DepositFee - number - Deposit amount required

Request Examples​

const res = await fetch('https://app.neoagent.co/chat/Chatbot/RealEstateCreate', {
  method: 'POST',
  headers: {
  "chatrobot-sessionkey": "<Your-Session-Key>"
},
  body: JSON.stringify({
  "SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
  "SaleType": "for_sale",
  "Status": "Active",
  "CurrencySymbol": "$",
  "PropertyType": "Single Family Residential",
  "Bedrooms": 3,
  "Bathrooms": 2.5,
  "Url": "https://example.com/property/123",
  "MLSNumber": "MLS123456",
  "YearBuilt": 1998,
  "DaysOnMarket": 2,
  "LotArea": 800,
  "BuildingArea": 2500,
  "AreaUnit": "Square Feet",
  "ParkingSpots": 8
})
});

const data = await res.json();
console.log(data);

Response​

The API response will be a JSON object with the following structure:

{
"Data": "PROP123456",
// string - API version
"Version": "1.0.0",
// boolean - Status of operation success
"Success": true,
// integer - HTTP status code
"Code": 200,
// string - Error message, if present
"Message": ""
}

Error Handling​

If the request fails, you should:

  1. Check the HTTP status code for network-level errors
  2. Examine the Code and Message fields in the response for business-level errors
  3. The Message field will contain detailed information about the error.