Sign in
UnitGroup

Create a unit group

Use this call to create a new unit group.<br>You must have at least one of these scopes: 'unitgroups.create, setup.manage'.

post/inventory/v1/unit-groups

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

codestring required

The code for the unit group that can be shown in reports and table views

propertyIdstring required

The id of the property where unit group will be created

nameobject required

The name for the unit group

descriptionobject required

The description for the unit group

maxPersonsinteger required

Maximum number of persons for the unit group

rankinteger nullable

The unit group rank Restrictions:

  • Should be greater or equal to one
type'BedRoom' | 'MeetingRoom' | 'EventSpace' | 'ParkingLot' nullable

The unit group type

Example request

{
  "code": "DBL",
  "propertyId": "MUC",
  "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": 1,
  "type": "BedRoom"
}

Response

Creation of the new unit group was successful.

idstring required

The unit group id

Example response

{
  "id": "MUC-DBL"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.