propertyIdstringrequired
Example:prop_8f2c1a
Media
List a property's media
get
Path Parameters
Response
200 application/json
Response
200 application/json
Media list
dataarray[object]
Show Child Parameters
get/properties/{propertyId}/media
Authentication
Path Parameters
200 application/json
Upload media
Photos, floor plans and documents are attached to the property, not to a listing.
post
Path Parameters
propertyIdstringrequired
Example:prop_8f2c1a
Body
multipart/form-data
Body
multipart/form-data
filestringrequired
categorystringrequired
Allowed values:cover_photointeriorexteriorfloor_planenergy_certificatedocument
orderinteger
>= 1
Example:1
captionstring
<= 160 characters
Response
application/json
Response
application/json
Uploaded
Media
idstring
Example:med_31c9
categorystring
Allowed values:cover_photointeriorexteriorfloor_planenergy_certificatedocument
urlstring(uri)
Example:https://cdn.realestateagency.example/properties/prop_8f2c1a/med_31c9.jpg
orderinteger
Example:1
captionstring
Example:Living room overlooking the courtyard
size_bytesinteger
Example:2418112
post/properties/{propertyId}/media
Authentication
Path Parameters
Body
No file selected
Error initializing code snippet
application/json
Import
Import a property data feed
Accepts an XML property-data feed or a ZIP with images, and creates or
updates the properties it contains. The import runs asynchronously.
post
Body
multipart/form-data
Body
multipart/form-data
filestringrequired
modestring
replace archives properties that aren’t in the file.
Allowed values:mergereplace
Default:merge
Response
202 application/json
Response
202 application/json
Import accepted
import_idstring
Example:imp_2f71
statusstring
Allowed values:in_progressdonefailed
properties_detectedinteger
Example:47
post/import/feed
Authentication
Body
No file selected
Error initializing code snippet
202 application/json