External apply link params can be provided by supported listing partners to identify or provision the property and preserve listing metadata through the renter application flow.

Examples

$ curl "https://app.tenantoptions.com.au/external_apply_link?street_number=12&street_name=Smith%20Street&suburb=Adelaide&state=SA&postcode=5000&office_email=office@example.com"

HTTP/1.1 200 OK
...

Params

Param name Description
street_number
optional

External apply link street number

Validations:

  • Must be a String

street_name
required

Street name

Validations:

  • Must be a String

suburb
required

Suburb

Validations:

  • Must be a String

state
required

State

Validations:

  • Must be a String

postcode
required

Postcode

Validations:

  • Must be a String

contact_name
optional

Contact name. Indexed values such as contact_name are supported

Validations:

  • Must be one of: Hash, String.

contact_email
optional

Contact email. Indexed values such as contact_email are supported

Validations:

  • Must be one of: Hash, String.

office_name
optional

Office name

Validations:

  • Must be a String

office_email
required

Office email

Validations:

  • Must be a String

office_phone
optional

Office phone

Validations:

  • Must be a String

referrer_group
optional

Referrer group

Validations:

  • Must be a String

referrer_id
optional

Referrer ID

Validations:

  • Must be a String

referrer_url
optional

Referrer URL

Validations:

  • Must be a String

listing_id
optional

Listing ID

Validations:

  • Must be a String

listing_image
optional

Listing image URL

Validations:

  • Must be a String