propertyIdstringrequired
Example:prop_8f2c1a
Archive a property
Takes the property off the market. The record remains readable.
delete
Path Parameters
Response
Response
Archived
delete/properties/{propertyId}
Authentication
Path Parameters
Media
List a property's media
get
Path Parameters
propertyIdstringrequired
Example:prop_8f2c1a
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