Property: post

Create a new Property.

Request - POST https://api-uat.vtopenview.com/property

You will need to supply a request body with this method.
You will need to sent on request your access token. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- POST Base URI: https://api-uat.vtopenview.com/property --header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Request Body

Example request body:

Content-Type: application/json { "lettings_properties": [ { "address": { "houseno": "string", "address1": "string", "address2": "string", "town": "string", "county": "string", "postcode": "string", "latitude": decimal, "longitude": decimal, "geocodingverified": boolean, "countryname": "string", "countrydisplayname": "string", "fulladdress": "string", "shortaddress": "string" }, "internalreference": "string", "negotiator": { "userid": long, "name": "string", "email": "string" }, "branch": { "branchid": integer, "branchname": "string" }, "status": "string", "archived": boolean, "appraisal": boolean, "commercialunit": boolean, "vattype": "string", "managementtype": "string", "managementfeetype": "string", "managementfeeamount": decimal, "lettingfeetype": "string", "lettingfeeamount": decimal, "authorisedexpenseamount": decimal, "estimatedrentalvalue": decimal, "counciltaxband": "string", "agreementname": "string", "alarmed": boolean, "entrycode": "string", "requireshmolicence": boolean, "hmoexpirydate": "date", "electforrentontime": boolean, "rentontimeenddate": "date", "landlords": [ { "landlordid": long, "name": "string", "email": "string", "primary": boolean, } ], "information": { "meters": { "eletricmeterserialnumber": "string", "eletricmeterlocation": "string", "gasmeterserialnumber": "string", "gasmeterlocation": "string", "watermeterserialnumber": "string", "watermeterlocation": "string", "oilmeterserialnumber": "string", "oilmeterlocation": "string", "meterlocationnotes": "string", }, "ukcouncil": "string", "refusecollectionday": "string", "collectionpoint": "string", "stopcocklocation": "string", "comments": "string", "accessinformation": "string" "mortgage": { "provider": "string", "termyears": integer, "totalvalue": decimal, "deposit": decimal, "interestrate": decimal, "monthlypayment": decimal, "total": decimal, }, "yield": { "gross": decimal, "net": decimal, "roi": decimal, }, }, "marketing": { "rent": decimal, "deposit": decimal, "bedrooms": integer, "bathrooms": integer, "receptions": integer, "currency": "string" "advertising": { "advertise": boolean, "newbuild": boolean, "dateavailablefrom": "datetime", "boardstatus": "string", "propertyarea": "string", "virtualtoururl": "string", "virtualtourtwourl": "string", "advertisingstatus": "string", "advertisingaddress": "string", "advertisingurl": "string", "pets": boolean, "smokers": boolean, }, "matching": { "leaseperiod": "string", "minlease": integer, "maxlease": integer, "propertytype": "string", "propertytypezoopla": "string", "propertyattributes": [ { "attribute": "string", } ], }, "descriptions": { "main": "string", "summary": "string", "extra1": "string", "extra2": "string", "advertisingsmsmessage": "string", }, "others": { "landusage": "string", "size": integer, "measurementunits": "string", "directions": "string", }, }, "udf": [ { "udfid": long, "value": "string" } ] } ] }

Status:

The list below describes the possible status for properties. This field is required.
If your company has set up other statuses on OpenView, please verify the string you are sending.

Prospect
Live
Archived

Example field on request:

"status": "Live"

Vat Types:

The list below describes the possible vat types for property. This field is optional.

Included
Excluded
Exempt

Example field on request:

"vattype": "Included"

Management Type:

The list below describes the possible Management Types for properties. This field is optional.

Fully Managed
Rent Collect
Let Only

Example field on request:

"managementtype": "Fully Managed"

Refuse Collection Day:

The list below describes the possible Refuse Collection Day for properties. This is the name of weekday. This field is optional.

Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

Example field on request:

"refusecollectionday": "Tuesday"

Information Mortgage Providers:

The list below describes the possible Mortgage providers for properties. This field is optional.

Barclays
HSBC
Lloyds
Nationwide
Royal Bank of Scotland (RBS)
Santander

Example field on request:

"provider": "Lloyds"

Marketing Let Type:

The list below describes the possible Let types for properties. This field is optional.

Commercial
Long Term
Not Specified
Short Term
Student

Example field on request:

"lettype": "Long Term"

Marketing Advertising Status:

The list below describes the possible Advertising Status types for properties. This field is optional.

Available
Let Agreed
Under Offer

Example field on request:

"advertisingstatus": "Let Agreed"

Marketing Matching Property Type:

The list below describes the possible Property types for properties. This follow the same property types from Rightmove. This field is optional.

Not Specified
Terraced House
End of Terrace House
Semi-Detached House
Detached House
Mews House
Cluster House
Ground Floor Flat
Flat
Studio Flat
Ground Floor Maisonette
Maisonette
Bungalow
Terraced Bungalow
Semi-Detached Bungalow
Detached Bungalow
Mobile Home
Land (Residential)
Link Detached House
Town House
Cottage
Chalet
Character Property
House
Villa
Apartment
Penthouse
Fina
Barn Conversion
Serviced Apartment
Parking
Sheltered Housing
Retirement Property
House Share
Flat Share
Park Home
Garages
Farm House
Equestrian Facility
Duplex
Triplex
Longere
Gite
Barn
Trulli
Mill
Ruins
Restaurant
Cafe
Castle
Village House
Cave House
Cortijo
Farm Land
Plot
Country House
Stone House
Caravan
Lodge
Log Cabin
Manor House
Stately home
Off-Plan
Semi-Detached Villa
Detached Villa
Bar/Nightclub
Shop
Riad
House Boat
Hotel Room
Block of Apartments
Private Halls
Office
Business Park
Serviced Office
Retail Property (High Street)
Retail Property (Out of Town)
Convenience Store
Hairdresser/Barber Shop
Hotel
Petrol Station
Post Office
Pub
Workshop & Retail Space
Distribution Warehouse
Factory
Heavy Industrial
Industrial Park
Light Industrial
Storage
Showroom
Warehouse
Land (Commercial)
Commercial Development
Industrial Development
Residential Development
Commercial Property
Data Centre
Farm
Healthcare Facility
Marine Property
Mixed Use
Research & Development Facility
Science Park
Guest House
Hospitality
Leisure Facility
Takeaway
Childcare Facility
Smallholding
Place of Worship
Trade Counter
Coach House
House of Multiple Occupation
Sports facilities
Spa
Campsite & Holiday Village

Example field on request:

"propertytype": "Detached House"

Marketing Matching Property Type Zoopla:

The list below describes the possible Property types for properties. This follow the same property types from Zoopla. This field is optional.

Terraced
End Terrace
Semi Detached
Detached
Mews
Flat
Studio
Maisonette
Bungalow
Terraced Bungalow
Semi-Detached Bungalow
Detached Bungalow
Land
Link Detached
Town House
Cottage
Chalet
Villa
Finca
Barn Conversion
Parking
Park Home
Farmhouse
Equestrian
Longere
Restaurant
Chateau
Country House
Lodge
Retail
Riad
House Boat
Block of Flats
Office
Business Park
Hotel
Pub/Bar
Industrial
Light Industrial
Warehouse
Farm
Leisure

Example field on request:

"propertytypezoopla": "Detached"

Marketing Others Measurement Units:

The list below describes the possible Measurement Units types for properties. This field is optional.

sqm
sqft

Example field on request:

"measurementunits": "sqft"

Response

If successful, this method returns a response body with the following structure:

Example response:

HTTPS 200 OK Content-Type: application/json { "lettings_properties": [ { "propertyid": long, "address": { "houseno": "string", "address1": "string", "address2": "string", "town": "string", "county": "string", "postcode": "string", "latitude": decimal, "longitude": decimal, "geocodingverified": boolean, "countryname": "string", "countrydisplayname": "string", "fulladdress": "string", "shortaddress": "string" }, "internalreference": "string", "negotiator": { "userid": long, "name": "string", "email": "string" }, "branch": { "branchid": integer, "branchname": "string" }, "status": "string", "archived": boolean, "appraisal": boolean, "commercialunit": boolean, "vattype": "string", "managementtype": "string", "managementfeetype": "string", "managementfeeamount": decimal, "lettingfeetype": "string", "lettingfeeamount": decimal, "authorisedexpenseamount": decimal, "estimatedrentalvalue": decimal, "counciltaxband": "string", "agreementname": "string", "alarmed": boolean, "entrycode": "string", "requireshmolicence": boolean, "hmoexpirydate": "date", "electforrentontime": boolean, "rentontimeenddate": "date", "landlords": [ { "landlordid": long, "name": "string", "email": "string", "primary": boolean, } ], "compliance": { "safetychecks": [ { "type": "string", "responsability": "string", "duedate": "date", "boilerservice": boolean, } ], "energyefficiencycurrent": integer, "energyefficiencypotential": integer, "enviromentalimpactcurrent": integer, "enviromentalimpactpotential": integer, "epc": { "rrnnumber": "string", "expirydate": "date", }, "notes": "string" }, "information": { "meters": { "eletricmeterserialnumber": "string", "eletricmeterlocation": "string", "gasmeterserialnumber": "string", "gasmeterlocation": "string", "watermeterserialnumber": "string", "watermeterlocation": "string", "oilmeterserialnumber": "string", "oilmeterlocation": "string", "meterlocationnotes": "string", }, "ukcouncil": "string", "refusecollectionday": "string", "collectionpoint": "string", "stopcocklocation": "string", "comments": "string", "accessinformation": "string" "mortgage": { "provider": "string", "termyears": integer, "totalvalue": decimal, "deposit": decimal, "interestrate": decimal, "monthlypayment": decimal, "total": decimal, }, "yield": { "gross": decimal, "net": decimal, "roi": decimal, }, }, "marketing": { "rent": decimal, "deposit": decimal, "bedrooms": integer, "bathrooms": integer, "receptions": integer, "currency": "string" "advertising": { "advertise": boolean, "newbuild": boolean, "dateavailablefrom": "datetime", "boardstatus": "string", "propertyarea": "string", "virtualtoururl": "string", "virtualtourtwourl": "string", "advertisingstatus": "string", "advertisingaddress": "string", "advertisingurl": "string", "pets": boolean, "smokers": boolean, }, "matching": { "leaseperiod": "string", "minlease": integer, "maxlease": integer, "propertytype": "string", "propertytypezoopla": "string", "propertyattributes": [ { "attribute": "string", } ], }, "descriptions": { "main": "string", "summary": "string", "extra1": "string", "extra2": "string", "advertisingsmsmessage": "string", }, "others": { "landusage": "string", "size": integer, "measurementunits": "string", "directions": "string", }, }, "media": [ { "type": "string", "caption": "string", "urlprimary": "string", "urlsmall": "string", "urllarge": "string", "room": "string", "roomtype": "string", "dateadded": "datetime", } ], "udf": [ { "udfid": long, "value": "string" } ] } ] }