POST app.tenantoptions.com.au/api/v1/enquiries
Add enquiry for a property

Prospective renters enquire about properties they wish to inspect and apply to obtain a lease in a rental property. Tenant Options allows agencies to manage enquiries in a convenient platform with automation when an enquiry has been made to one of their properties. This endpoint allows agencies and other vendors to send enquiries for a property to Tenant Options to ease and streamline the leasing process for agents.

Supported Formats

json

Examples

Add an enquiry for a property using the listingId:
{
  "enquiry": {
    "name": "John Smith",
    "email": "john.smith@example.com",
    "phone": "0400000000",
    "message": "Does this property allow pets?"
  },
  "property": {
    "listingId": "ABC123",
    "full_address": "123 Smith Street, Townsville, SA, 5000"
  }
}

Add an enquiry with minimal contact details enquiring for a property using the address parts:
{
  "enquiry": {
    "name": "John Smith",
    "email": "john.smith@example.com",
  },
  "property": {
    "full_address": "1/123 Smith Street, Townsville, SA, 5000",
    "address_parts": {
      "unit_number": "1",
      "street_number": "123",
      "street_name": "Smith Street",
      "suburb": "Townsville",
      "state": "SA",
      "postcode": "5000"
    }
  }
}

Params

Param name Description
enquiry
required

Validations:

  • Must be a Hash
enquiry[name]
required

First name, middle name (if applicable) and last name separated by a space

Validations:

  • Must be a String
enquiry[email]
required

Email address

Validations:

  • Must be a String
enquiry[phone]
optional

Phone number

Validations:

  • Must be a String
enquiry[message]
optional

Message for the property manager

Validations:

  • Must be a String
property
required

Validations:

  • Must be a Hash
property[listingId]
optional

Listing ID found in REAXML feeds. This field is the preferred way to find a property

Validations:

  • Must be a String
property[full_address]
required

The full address as a single string. The full address is used after listingId and address_parts, respectivly

Validations:

  • Must be a String
property[address_parts]
optional

Validations:

  • Must be a Hash
property[address_parts][unit_number]
optional

Validations:

  • Must be a String
property[address_parts][street_number]
optional

Validations:

  • Must be a String
property[address_parts][street_name]
optional

Street name including the street suffix

Validations:

  • Must be a String
property[address_parts][suburb]
optional

Validations:

  • Must be a String
property[address_parts][state]
optional

Validations:

  • Must be a String
property[address_parts][postcode]
optional

Validations:

  • Must be a String

Returns

Code: 201

Description:

Enquiry has been created

Param name Description
status
required

Validations:

  • Must be one of: ok.

Code: 200

Description:

Enquiry has been updated

Param name Description
status
required

Validations:

  • Must be one of: ok.

Code: 400

Description:

Bad request. Ensure all required fields have been provided

Param name Description
status
required

Validations:

  • Must be one of: bad request.

Code: 401

Description:

Unauthorised. Ensure X-API-KEY field is correct

Param name Description
status
required

Validations:

  • Must be one of: unauthorised.

Code: 404

Description:

Property not found

Param name Description
status
required

Validations:

  • Must be one of: not found.

Code: 500

Description:

Unexpected server error. The support team has been notified

Param name Description
status
required

Validations:

  • Must be one of: error.

Code: 502

Description:

Downstream service error. The support team has been notified. Try again later

Param name Description
status
required

Validations:

  • Must be one of: error.

Headers

Header name Description
X-API-KEY
required 		API key provided by systems@tenantoptions.com.au