Skip to main content

Create or update an apartment

POST 

/v2/apartment

Operation ID: upsertApartment

Creates the apartment on the first call for a providerApartmentId and updates it on later calls; call it first, because all other apartment endpoints need the apartment to exist. Updates are not partial: always send the complete apartment object, as most omitted fields are cleared (leaving out providerApartmentGroupId removes a unit from its multi-unit). New apartments are inactive until you call PUT /v2/apartment/activate; on creation providerApartmentId may only contain letters, digits and ._:- (at most 120 characters).

Request​

Responses​

Successful creation or update of an apartment