GUguesty
Complexes

Update complex details

Updates the details of a specific complex based on the complexId, and returns the modified values

put/properties-api/complexes/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/properties-api/complexes/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required

The id of the complex to update

Request body

titlestring

The title of the Complex

nicknamestring

The nickname of the Complex. Useful in searches

tagsstring[]

An array containing Tags for this Complex

Example request

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

Response

The complex was updated successfully

idstring
titlestring
nicknamestring
tagsstring[]

Example response

{
  "id": "645774fe76e5da340bf915e7",
  "title": "Complex 1",
  "nickname": "C1",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.