Skip to main content

Real Estate Delete

The Real Estate API of app.neoagent.co provides functionality to delete real estate by sending a POST request to the /chat/Chatbot/RealEstateDelete endpoint.

warning

Attention: This API is compatible only with traditional chatbots and is not yet compatible with template-based chatbots.

Endpoint

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

Required Headers

The API request must include the following headers:

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

Request Body

The body of the request must contain the following parameters:

{
// string, required - Chatbot ID (available in chatbot settings -> general -> chatbot ID)
"SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
// array, required - Array of property identifiers to delete
"Keys": [
"PROP123456",
"PROP789012"
],
// string, required - Must be one of: [NewOaks, MLSNumber, URL]
"KeyType": "NewOaks"
}

Parameters

  • serialNumber - string, required - Unique identifier (ID) of the chatbot
  • rows - array of objects, required - List of Google Sheet data. //In each row element, fields like URL, name, product name, and price are dynamically defined custom fields. //Their definitions and values are determined by the user and can be modified based on specific requirements.

Request Examples

const res = await fetch('https://app.neoagent.co/chat/Chatbot/RealEstateDelete', {
method: 'POST',
headers: {
"chatrobot-sessionkey": "<Your-Session-Key>"
},
body: JSON.stringify({
"SerialNumber": "3254a9d0424c4806b9ea3d0763xxxxxx",
"Keys": [
"PROP123456"
],
"KeyType": "NewOaks"
})
});

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

Response

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

{
// object - The deletion result
"Data": {
"SuccessCount": 1
},
// string - API version
"Version": "1.0.0",
// boolean - Operation success status
"Success": true,
// integer - HTTP status code
"Code": 200,
// string - Error message if any
"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