Search
K
[dev] 🇩🇪 Listings Management Germany

Create a new project

Create a new project. A project is a collection of listings that are related to each other. For instance, a project can be a building that contains several apartments for sale. This endpoint allows you to create a new project

post

Body

application/json; charset=utf-8

projectRequest

Request wrapper for Data

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired

metadata associated with the project in Immowelt system.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json; charset=utf-8

Created

projectResponse

Response wrapper for Data

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
metadataobject

metadata associated with the project in Immowelt system.

* Additional properties are NOT allowed.
Show Child Parameters
contactobject
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]

Array of media items attached to the listing.

Show Child Parameters
post/projects

Body

{ "data": {}, "metadata": { "source": { "offererMarketingKey": "HH-AH61a-WE15a-1", "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981" } } }
 
application/json; charset=utf-8

Retrieve an existing project

Retrieve a project

get

Path Parameters

externalProjectIdstringrequired

The Unique Identifier of the project.

Example:project123

Response

application/json; charset=utf-8

Accepted

projectResponse

Response wrapper for Data

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
metadataobject

metadata associated with the project in Immowelt system.

* Additional properties are NOT allowed.
Show Child Parameters
contactobject
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]

Array of media items attached to the listing.

Show Child Parameters
get/projects/{externalProjectId}
 
application/json; charset=utf-8

Update an existing project

Update a project

put

Path Parameters

externalProjectIdstringrequired

The Unique Identifier of the project.

Example:project123

Body

application/json; charset=utf-8

projectRequest

Request wrapper for Data

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired

metadata associated with the project in Immowelt system.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json; charset=utf-8

Accepted

requestIdstring

The unique identifier for this update request

Example:0196106c-409b-7fg4-a317-db7393a36b77

externalProjectIdstring

The Unique Identifier of the project.

Example:project123

warningsarray
Show Child Parameters
put/projects/{externalProjectId}

Body

{ "data": {}, "metadata": { "source": { "offererMarketingKey": "HH-AH61a-WE15a-1", "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981" } } }
 
application/json; charset=utf-8

Delete an existing project

Delete a project

delete

Path Parameters

externalProjectIdstringrequired

The Unique Identifier of the project.

Example:project123

Response

application/json; charset=utf-8

Accepted

requestIdstring

The unique identifier for this delete request

Example:0196106c-409b-7fg4-a317-db7393a36b77

externalProjectIdstring

The Unique Identifier of the project.

Example:project123

delete/projects/{externalProjectId}
 
application/json; charset=utf-8

Assign listings to a project

Assign listings to a project

post

Path Parameters

externalProjectIdstringrequired

The Unique Identifier of the project.

Example:project123

Body

application/json; charset=utf-8
externalListingIdsarray[string]required

The external listing IDs to be assigned to the project.

Response

application/json; charset=utf-8

Accepted

requestIdstring

The unique identifier for this assign request

Example:0196106c-409b-7fg4-a317-db7393a36b77

externalProjectIdstring

The Unique Identifier of the project.

Example:project123

post/projects/{externalProjectId}/assign

Body

{ "externalListingIds": [ "[]" ] }
 
application/json; charset=utf-8