APapaleo
UnitGroup

Replace a unit group

Use this call to modify a unit group.<br>You must have at least one of these scopes: 'unitgroups.manage, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.unit_groups.modify'.

put/inventory/v1/unit-groups/{id}

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/inventory/v1/unit-groups/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: unitgroups.manage, setup.manage, admin

Path parameters

idstring required

The id of the unit group.

Request body

nameobject required

The name for the unit group

descriptionobject required

The description for the unit group

maxPersonsinteger

Maximum number of persons for the unit group. If this value is increased, the surcharges for the related rate plans must be specified in order for the rate plans to be sellable for the new possible occupancies.

rankinteger nullable

The unit group rank Restrictions:

  • Should be greater or equal to one

Example request

{
  "name": {
    "en": "Double Room",
    "de": "Doppelzimmer"
  },
  "description": {
    "en": "This is a nice room with as kingsize bed and flat screen",
    "de": "Dies ist ein schönes Zimmer mit Kingsize-Bett und Flachbildschirm"
  },
  "maxPersons": 4,
  "rank": 2
}

Response

Replace of the unit group was successful.

Changes

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