Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26176256241.4 KB
Leads Test Endpoint

Create a new group booking lead.

Creates given group booking lead in the system. Api client creating lead will have access to that lead's personal and confidential information.

post/api/v3.3/leads-test/group-booking

Request body

propertyUidstring required
agencyUidstring required
checkInLocalDateTimestring
checkOutLocalDateTimestring
checkInLocalDatestring date

Check in date. For specifying time, use checkInLocalDateTime.

checkOutLocalDatestring date

Check out date. For specifying time, use checkOutLocalDateTime.

status'BLOCKED' | 'NEW' | 'ON_HOLD' | 'CLOSED' | 'PENDING' | 'PENDING_APPROVED' | 'DECLINED' | 'BOOKED' | 'CANCELLED' | 'IGNORED' | 'DUPLICATE' | 'SAMPLE' required
bookedUtcDateTimestring
externalBookingIdstring

Ignored for BLOCK type of a lead

notesstring
extraNotesstring
referrerstring
channel'HOSTFULLY' | 'AIRBNB' | 'BOOKING_COM' | 'VRBO' | 'HVMB' | 'GOOGLE' | 'FIND_RENTALS' | 'FLATAWAY' | 'GOLIGHTLY' | 'HOMADS' | 'TRIP_ADVISOR' | 'VACAYMYMAY' | 'STAYMENTITY' | 'GETAWAYGOGO' | 'EVERYSTAY' | 'REDAWNING' | 'MISTERBNB' | 'WHIMSTAY' | 'KOPA' | 'OWNERDIRECT' | 'B0ARDING' | 'TRAVELSTAYTION' | 'BNBFINDER' | 'LODGELOVERS' | 'LAKE' | 'MINISTAYS' | 'TRAMONA' | 'NEXTPAX' | 'RENTALS_UNITED' | 'HOUFY' | 'VRASIO' | 'STAYNEARN' | 'BLUEGROUND' | 'ANYSTAY' | 'STAY' | 'CREWDOGS'

Represents the list of known channels in Lead API V3. This enum may be extended with additional values in API versions.API Clients must gracefully handle unmapped or unexpected entries with fallback or defaulting strategy to ensure safe behavior

hotelUidstring

In case hotelUid is not supplied, group-booking will assume that request is a master/sub property reservation

assigneeUidstring

Identifier of user assigned to lead in UID format

Example request

{
  "checkInLocalDateTime": "2026-04-20T11:52:36",
  "checkOutLocalDateTime": "2026-04-20T11:52:36",
  "guestInformation": {
    "arrivalLocalDateTime": "2026-04-20T11:52:36",
    "departureLocalDateTime": "2026-04-20T11:52:36"
  },
  "bookedUtcDateTime": "2026-04-20T11:52:36",
  "subLeads": [
    {
      "guestInformation": {
        "arrivalLocalDateTime": "2026-04-20T11:52:36",
        "departureLocalDateTime": "2026-04-20T11:52:36"
      }
    }
  ]
}

Response

OK