Enquiries

Sends an enquiry for listing, agency, etc... (based on the enquiry type and referenceid). Recipients and template will be automatically selected.

post/v1/enquiries

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
      Scopesapi_enquiries_write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

deliveryMethod'email' | 'sms'

Delivery method of the enquiry

enquiryType'listing' | 'devProject' | 'newDevLanding' | 'agencyProfile' | 'agentProfile' | 'contractRequest' | 'vendorEnquiry' | 'prePortalListing'

Type of enquiry

referenceIdinteger

Listing identifier

idstring

Enquiry identifier

subjectstring

Enquiry subject

messagestring

Enquiry message

metaDataobject

MetaData of the enquiry

Response

OK

s3Keystring
messagestring
enquiryReceiptTimestampstring date-time
warningsstring[]

Changes

No recorded changes to this operation across all 18 revisions of this API.