Group

Creates a group booking.

<br>You must have at least one of these scopes: 'groups.create, reservations.manage'.

post/booking/v1/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

namestring required

Name of the group

commentstring nullable

Additional information and comments

bookerCommentstring nullable

Additional information and comment by the booker

propertyIdsstring[] required

List of property ids the group booking belongs to

Example request

{
  "name": "apaleo Summer Festival 2027",
  "booker": {
    "title": "Mr",
    "gender": "Male",
    "firstName": "Jon",
    "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": "2018",
    "paymentMethod": "visa",
    "payerEmail": "s.hopper@test.com",
    "payerReference": "4ea6462b-cca3-4c17-a035-c7b5132db83c",
    "isVirtual": false
  },
  "registeredCard": {
    "cardNumber": "1111",
    "cardHolder": "John Doe",
    "expiryMonth": "8",
    "expiryYear": "2018",
    "paymentMethod": "visa",
    "payerEmail": "s.hopper@test.com",
    "note": "Credit card will be available after 2025-06-23 10:00:00",
    "isVirtual": false
  },
  "propertyIds": [
    "MUC"
  ]
}

Response

A new group booking was created.

idstring required

Id of newly created group booking

Example response

{
  "id": "XPGMSXGF"
}

Changes

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