Create a Group
POST /booking/v1/groups
{
"name": "Apaleo Summer Festival 2027",
"booker": {
"title": "Mr",
"gender": "Male",
"firstName": "John",
"middleInitial": "D",
"lastName": "Doe",
"email": "john.d@doe.com",
"phone": "+4989123343",
"address": {
"addressLine1": "My Street 1",
"postalCode": "12453",
"city": "MyCity",
"countryCode": "GB"
}
},
"paymentAccount": {
"accountNumber": "1111",
"accountHolder": "John Doe",
"expiryMonth": "8",
"expiryYear": "2028",
"paymentMethod": "visa",
"payerEmail": "s.hopper@test.com",
"payerReference": "4ea6462b-cca3-4c17-a035-c7b5132db83c",
"isVirtual": false
},
"comment": "3-night conference block, 2026-08-08 to 2026-08-11",
"bookerComment": "Organizer prefers all attendee correspondence via email",
"propertyIds": ["MUC"]
}
A few fields worth calling out:
bookeris the organiser, not a guest. It’s who the property calls with questions about the block, not necessarily anyone staying in a room.commentis internal-only, useful for reservations or sales staff working the group.bookerCommentis a note about the booker’s own preferences, also internal.propertyIdsis the array of property IDs the Group can hold Blocks at. For a single-property event, that is one element array, e.g.["MUC"]. For a multi-property allotment (an event spanning two nearby hotels, for example) include every property ID, e.g.["MUC", "BER"].
The response returns a groupId, a short alphanumeric code such as EQBOXNNQ. Every block you create next will reference it.
Deleting a group only works if it has no linked blocks, so clear or cancel blocks first if you need to tear one down.
Group Events - we send created, changed, and deleted group events you can observe using webhooks.