Raw schema
{
"type": "object",
"properties": {
"agency_uid": {
"description": "Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.",
"type": "string"
},
"property_uid": {
"type": "string",
"description": "The property's UID."
},
"status": {
"type": "string",
"enum": [
"BLOCKED",
"NEW"
],
"description": "BLOCKED = calendar block, NEW = inquiry."
},
"check_in": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
"description": "Check-in, property-local, YYYY-MM-DDTHH:MM:SS."
},
"check_out": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
"description": "Check-out, property-local, YYYY-MM-DDTHH:MM:SS."
},
"guest": {
"description": "Guest information โ needed for an inquiry, usually omitted for a block.",
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string",
"description": "Guest email (Hostfully requires it when guest info is given)."
},
"secondaryEmail": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"cellPhoneNumber": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zipCode": {
"type": "string"
},
"countryCode": {
"description": "Two-letter country code, e.g. US.",
"type": "string"
},
"flightNumber": {
"type": "string"
},
"reasonForTrip": {
"type": "string"
},
"arrivalLocalDateTime": {
"description": "Expected arrival, YYYY-MM-DDTHH:MM:SS.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$"
},
"departureLocalDateTime": {
"description": "Expected departure, YYYY-MM-DDTHH:MM:SS.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$"
},
"adultCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"childrenCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"infantCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"petCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"email"
]
},
"notes": {
"description": "Notes on the lead.",
"type": "string"
},
"external_booking_id": {
"description": "Your own reference for this lead.",
"type": "string"
}
},
"required": [
"property_uid",
"status",
"check_in",
"check_out"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}