Start a group: a party with one lead guest, to which rooms are then booked

Before you call

Credential

Authorization: Bearer $KEY

Scope

bookings:write

Mcp

rivier_lodging_group_create

Sdk

bookings.group.create

Cli

bookings group create

Request bodyapplication/json, required

• propertyIdstring (uuid)required
• namestringrequired
  At most 160 characters.
• leadobjectrequired
  • namestringrequired
    At most 160 characters.
  • emailstring (email)
    At most 254 characters.
  • phonestring
    Pattern: ^+?[0-9 ()-]{6,20}$.
  • companystring
    At most 160 characters.
• notesstring
  Default: . At most 2000 characters.

Responses

• 201application/json
  Success
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring