Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Complexes

Create a new complex

Create a new complex and return the ID of the newly created complex

post/properties-api/complexes

Request body

titlestring required

The title of the Complex

nicknamestring required

The nickname of the Complex. Useful in searches

propertyIdsstring[]

An array that contains Ids for propertyIds that belong to this Complex. Could be an empty array [] (default)

tagsstring[]

An array containing Tags for this Complex

Example request

{
  "title": "My Title",
  "nickname": "My Nickname",
  "propertyIds": [
    "63baba9c5c25ccae5595832b",
    "63babaab5c25ccae5595832c"
  ],
  "tags": [
    "Tag 1",
    "Tag 2"
  ]
}

Response

The ID of the newly created complex

idstring

Example response

{
  "id": "645788211c405b56beaf26c0"
}