Create Property

Create Property

Creates a new property from the provided data, associating it within the requester's scope.

Module: Properties

Returns: Master Data → Properties → Properties → PropertyRead (single)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2)

Required Account Permission: ManageProperty (24)

This will be evaluated against your used access token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

The tenant this property belongs to.

string
required
length ≤ 45

Identifier of the property at its property management company, which isn't necessarily unique.
Usually comes from the ERP system.

string
required
length ≤ 255

Name of the property.

string
required
length ≤ 255

Street and house number of the property's address.

string
required
length ≤ 255

Postal code of the property's address.

string
required
length ≤ 255

City of the property's address.

int32
required

Number the first resolution in the property's resolution collection gets.
Changing it renumbers the resolution collection.

string | null

External ID of the property, unique within the creator party, across both properties and entrances.
More info: External IDs

string | null
deprecated

Previous identifier of the property in an external system, e.g. from an ERP system used before.

double | null
-90 to 90

Latitude of the property's location.

double | null
-180 to 180

Longitude of the property's location.

int32 | null

Reference to the File with the image of the property.

Headers
string
Defaults to en-DE

Language preference header. Allowed languages: German (en-DE).

string
Defaults to 2.0

API version to use (1 or 2) either with trailing .0 or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).

Responses

401

Error: Unauthorized

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json