Your gateway password. Can be found by logging into your account,
clicking on the "My Account".
Process this transaction in test mode? 0 = Not a Test Transaction (will process your ad) 1 = Test Mode (will validate xml / data only)
The unique adID that we generate when the ad is created. If the adID is not supplied we will create a brand new ad.
If you do supply an adID we will update that ads information.
This is Your Unique ID. This will allow you to update your ads without having to
store our ID's on your system. Example: The first time you feed an ad with a source id of
"A12345" it will create a new ad. The next time your feed an ad with the same source id "A12345"
it will update your original ad on our system with new information. It will not create a new ad.
This will allow you to change the status of the ad on our system. 1 = Activate(available for the public to see) 2 = De-Activate(available for property manager to see but not the public) 3 = Delete(ad gets archived so no one can see the ad, however it isn't removed from the system)
Allows you to override the default API you are posting to. If posting to FreeRentalSite.com
and you do not supply a segmentID it will default to 1. If posting to www.FreeRentalSite.com and you
supply a segmentID of 2 then your ad will be posted to www.FreeCommercialSite.com. This will allow you
to post Rental, Commercial, Real Estate, and Vacation Rental Ads in one feed.
***Note by overriding the default segmentID you will be validated against
that site's API. 1 = www.FreeRentalSite.com 2 = www.FreeCommercialSite.com 3 = www.FreeRealEstateSite.com 4 = www.FreeVacationRentalSite.com
The country code of the property.
E.g. United States = US. Please choose from a list below: AU = Australia BS = Bahamas BD = Bangladesh BM = Bermuda BR = Brazil BG = Bulgaria CA = Canada CN = China CO = Colombia CD = Democratic Republic of the Congo DK = Denmark EG = Egypt ET = Ethiopia FI = Finland FR = France DE = Germany GR = Greece IN = India ID = Indonesia IR = Iran IE = Ireland IT = Italy JP = Japan KE = Kenya LT = Lithuania MX = Mexico ME = Montenegro MM = Myanmar NL = Netherlands NZ = New Zealand NG = Nigeria NO = Norway PK = Pakistan PA = Panamá PH = Philippines PL = Polska PR = Puerto Rico QA = Qatar RU = Russia KN = Saint Kitts and Nevis SG = Singapore ZA = South Africa KR = South Korea ES = Spain SE = Sweden CH = Switzerland TW = Taiwan TZ = Tanzania TH = Thailand TR = Turkey UA = Ukraine AE = United Arab Emirates GB = United Kingdom US = United States VN = Vietnam
The name of the State / Region / Province / Voivodship that the property is located in. E.g. "New York" is a State located in the United States of America.
The <stateName> must be spelled exactly as it is found in our system. Select from the list below:Select Your Country:
The name of the City / Town / Village that the property is located in. E.g. "Toronto" is a city located in Ontario, Canada.
The primary address of the property. E.g. "123 Main Street"
The secondary address of the property. E.g. "Suite 202"
The tertiary address of the property. E.g. "Office space 5"
The postal code of the property. E.g. Poland: "32-015", Canada: "M4B 1C4", United States: "80918"
The title of the Ad.
The detailed description of the property / unit.
The description of any current move-in specials offered for this property / unit.
This is a permanent URL pointing to a webpage containing information regarding this property or your company. ***Only available for upgraded ads
This is a URL pointing to an online rental application.
This is a URL pointing to a webpage containing a virtual tour of the property / unit.
Allows you to delete all images attached to this ad. Will only be used when updating an existing ad. 0 = Don't Delete / Ignore Parameter
1 = Delete All Images
A comma seperated list of URL's for each Image to be attached to this Ad.
These images will be downloaded to our server, resized / optimized for performance,
and watermarked for security. We will also create a thumbnail to ensure our search results
load quickly for the end user. In the example below you will see we have three images
(House, Kitchen, Living Room):
A comma seperated list of Captions for the Images being attached to this ad. Must have one comma / item
per image even if the image doesn't have a caption. In the example below we have added a caption to our
1st and 3rd image, but not the 2nd:
View from the road, ,Living Room,
The name of the person that will be listed as the contact on the ad.
The name of the company that will be listed as the contact on the ad.
Email address of the person / entity to contact. This will be used to send any
correspondences from the contact button / lead form on the ad.
This is the licence number of the company / entity that is posting the ad.
Primary Contact Phone # displayed on the Ad.
Primary Contact Phone's Extension
The name of the person that will be listed as the secondary contact on the ad.
Email address of the secondary person to contact. This will be used to send any
correspondences from the contact button / lead form on the ad.
Secondary Contact Phone # displayed on the Ad.
Secondary Contact Phone's Extension
The type of property being listed. Must select one of the options below: 1 = Single Family House 2 = Townhouse 3 = Condo 4 = Apartment 5 = Loft 6 = Multiplex 30 = Mobile Home 31 = Other 32 = Duplex 39 = Corporate Housing
Ad is a Multi Unit Listing. Allows you to supply a range of values for Rent / Deposit / Area / Beds / Baths.
Note: If not supplied this will default to 0 for single unit listing. 0 = NOT a Multi Unit Listing. Single Unit Listing Only
1 = Multi Unit Listing
The currency type for all financial fields of the ad. E.g.: Rent Amount / Purchase Price / Deposit / Taxes.
Must select one of the options below: 1 = United States Dollar (USD) 2 = Canadian Dollar (CAD) 3 = Australian Dollar (AUD) 4 = New Zealand Dollar (NZD) 5 = Hong Kong Dollar (HKD) 6 = Euro (EUR) 7 = Japanese Yen (JPY) 8 = Pound Sterling (GBP) 9 = Swiss Franc (CHF) 10 = Swedish Krona (SEK) 11 = Norwegian Krone (NOK) 12 = Mexican Peso (MXN) 13 = Singapore Dollar (SGD) 14 = South Korean Won (KRW) 15 = Indian Rupee (INR) 16 = Chinese Yuan (CNY) 17 = Polish zloty (PLN) 18 = Israeli shekel (ILS) 19 = Singapore Dollar (SGD) 20 = Czech koruna (CZK) 21 = Danish krone (DKK) 22 = New Taiwan Dollar (TWD) 23 = Brazilian real (BRL) 24 = South African rand (ZAR) 25 = Indonesian Rupiah (IDR) 26 = Bangladeshi taka (BDT) 27 = Pakistani rupee (PKR) 28 = Nigerian naira (NGN) 29 = Russia Rubles (RUB) 30 = Panamanian Balboa (PAB) 31 = Iran Rials (IRR) 32 = Turkish Lira (TRY) 33 = Congolese Franc (CDF) 34 = Thailand Baht (THB) 35 = Myanma kyat (MMK) 36 = Philippine peso (PHP) 37 = Colombian peso (COP) 38 = Ukrainian hryvnia (UAH) 39 = Tanzanian shilling (TZS) 40 = Bulgarian lev (BGN) 41 = Singapore Dollar (SGD) 42 = Lithuanian litas (LTL) 43 = Bahamian dollar (BSD) 44 = East Caribbean Dollar (XCD) 45 = Kenyan shilling (KES)
Rent Amount of the property being listed.
Maximum Rent Amount of the property being listed.
For Multi Unit Listing Only
The frequency at which the rent is collected. Must select one of the options below: 1 = Amt / Night 2 = Amt / Week 4 = Amt / Month 6 = Amt / Quarter 8 = Amt / Year
The amount of the deposit according to the terms of the lease, or sale.
Maximum Deposit Amount for the property being listed. For Multi Unit Listing Only
A description of the deposit. This can be used instead of deposit if you would prefer to use text instead of a monetary value.
The fee amount that is required to apply for the property being listed.
The number of bedrooms the property has.
Maximum # of bedrooms offered in a unit for the property being listed. For Multi Unit Listing Only