externalListingIdstringrequired
The Unique Identifier of the listing. Can be:
- Your own offererEstateId that was used when creating a listing
Example:2592IWF02EC6
Retrieve an existing listing
Retrieves a listing
get
Path Parameters
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Accepted
listingResponse
Listing
* Additional properties are NOT allowed.
listingobjectrequired
Show Child Parameters
get/listings/{externalListingId}
Authentication
Path Parameters
application/json; charset=utf-8
Update an existing listing
Updates a listing
put
Path Parameters
externalListingIdstringrequired
The Unique Identifier of the listing. Can be:
- Your own offererEstateId that was used when creating a listing
Example:2592IWF02EC6
Body
application/json; charset=utf-8
Body
application/json; charset=utf-8
apiRequest
Request wrapper for Data
* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired
metadatas associated to listing in Aviv system
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
contactobject
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Accepted
requestIdstring
The unique identifier for this update request
Example:0196106c-409b-7fg4-a317-db7393a36b77
listingIdstring
The Immowelt ID for the listing
Example:a1b2c3d4-e5f6-4789-b0a1-c2d3e4f5a6b7
externalListingIdstring
Your own offererEstateId that was used when creating the listing
Example:offererEstateId123
warningsarray
Show Child Parameters
put/listings/{externalListingId}
Authentication
Path Parameters
Body
{
"data": {
"estateType": "HOUSE",
"distributionType": "BUY",
"location": {
"postalcode": "22455",
"city": "Hamburg",
"street": "Hauptstrasse",
"houseNumber": "10",
"country": "DEU",
"geometry": {
"type": "Point",
"coordinates": [
13.405,
52.52
]
}
},
"prices": {}
},
"metadata": {
"source": {
"offererMarketingKey": "HH-AH61a-WE15a-1",
"offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981"
}
}
}
application/json; charset=utf-8
Delete an existing listing
Deletes a listing
delete
Path Parameters
externalListingIdstringrequired
The Unique Identifier of the listing. Can be:
- Your own offererEstateId that was used when creating a listing
Example:2592IW-F02EC6
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Accepted
requestIdstring
The unique identifier for this delete request
Example:0196106c-409b-7fg4-a317-db7393a36b77
listingIdstring
The Immowelt ID for the listing
Example:a1b2c3d4-e5f6-4789-b0a1-c2d3e4f5a6b7
externalListingIdstring
Your own offererEstateId that was used when creating the listing
Example:offererEstateId123
delete/listings/{externalListingId}
Authentication
Path Parameters
application/json; charset=utf-8
Media
Request presigned URLs to upload media files.
Request a presigned URL for media upload
Request a presigned URL to upload a media file to the system.
The presigned URL is valid for 60 seconds. During this time:
- The upload must be completed.
- The media must be attached to a listing.
If these conditions are not met, the media will be automatically deleted. Supported media types include images, videos, and other multimedia content. Note: The maximum file size allowed is 40MB.
post
Body
application/json; charset=utf-8
Body
application/json; charset=utf-8
mediaPresignedUrlRequest
* Additional properties are NOT allowed.
externalMediaIdstringrequired
The ID of the media into the software
>= 1 characters
Example:media_01
fileNamestringrequired
The name of the media file.
Match pattern:.*\S.*
>= 1 characters
Example:my_media.jpg
Response
application/json; charset=utf-8
Response
application/json; charset=utf-8
Created
mediaPresignedUrlResponse
externalMediaIdstringrequired
The external media identifier provided by the client
presignedURLstring(uri)required
Presigned URL to upload media
Example:https://s3.eu-central-1.amazonaws.com/aviv-media/1234567890.jpg
post/medias
Authentication
Body
{
"externalMediaId": "media_01",
"fileName": "my_media.jpg"
}
application/json; charset=utf-8