--- agentTools: projectIndex: https://dev.hostfully.com/llms.txt --- # Place inquiry on hold Places an inquiry on hold. The holds lasts 24h by default, but can be changed in agency's settings # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Hostfully API", "license": { "name": "Apache 2.0", "url": "https://www.hostfully.com/" }, "version": "v3.0.1" }, "externalDocs": { "description": "Hostfully Documentation", "url": "https://dev.hostfully.com/v3.0/reference" }, "servers": [ { "url": "https://sandbox-api.hostfully.com" } ], "security": [ { "JWT-Authentication": [] }, { "Agency-API-key": [] } ], "paths": { "/api/v3.3/leads/{leadUid}/put-on-hold": { "post": { "tags": [ "Leads" ], "summary": "Place inquiry on hold", "description": "Places an inquiry on hold. The holds lasts 24h by default, but can be changed in agency's settings", "operationId": "putLeadOnHold", "parameters": [ { "name": "leadUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/LeadApi3SingleResourceResponseLeadApiV3_1Dto" } } } } } } } }, "components": { "schemas": { "LeadGuestInformationForCreationApiV3Dto": { "required": [ "email" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "lastName": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "address1": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "address2": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "zipCode": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "city": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "state": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "countryCode": { "type": "string", "description": "Replaced with null if api caller has no access to see lead's personal and confidential information", "enum": [ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AG", "AN", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BQ", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "YT", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FJ", "FI", "FK", "FO", "FR", "GF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GN", "GW", "GY", "GP", "HT", "VA", "HN", "HK", "HL", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "JM", "JP", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LC", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MQ", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "MX", "FM", "MD", "MC", "MN", "MS", "MA", "MZ", "MM", "ME", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "NO", "OM", "PK", "PW", "PA", "PG", "PS", "PY", "PE", "PF", "PH", "PL", "PN", "PT", "PR", "QA", "RO", "RU", "RW", "KN", "WS", "RE", "PM", "SH", "ST", "SM", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "ES", "LK", "SR", "SJ", "SZ", "SE", "CH", "SY", "TC", "TW", "TJ", "TZ", "TH", "TG", "TO", "TT", "TN", "TR", "TM", "TV", "UG", "UA", "AE", "GB", "JE", "IM", "US", "UY", "UZ", "VC", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "YU", "ZM", "ZW" ] }, "passportId": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "passportCountryCode": { "type": "string", "description": "Replaced with null if api caller has no access to see lead's personal and confidential information", "enum": [ "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AG", "AN", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "BN", "BG", "BF", "BI", "BQ", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "YT", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FJ", "FI", "FK", "FO", "FR", "GF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GN", "GW", "GY", "GP", "HT", "VA", "HN", "HK", "HL", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "JM", "JP", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LC", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MQ", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "MX", "FM", "MD", "MC", "MN", "MS", "MA", "MZ", "MM", "ME", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "NO", "OM", "PK", "PW", "PA", "PG", "PS", "PY", "PE", "PF", "PH", "PL", "PN", "PT", "PR", "QA", "RO", "RU", "RW", "KN", "WS", "RE", "PM", "SH", "ST", "SM", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "ES", "LK", "SR", "SJ", "SZ", "SE", "CH", "SY", "TC", "TW", "TJ", "TZ", "TH", "TG", "TO", "TT", "TN", "TR", "TM", "TV", "UG", "UA", "AE", "GB", "JE", "IM", "US", "UY", "UZ", "VC", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "YU", "ZM", "ZW" ] }, "adultCount": { "type": "integer", "description": "In case it is not supplied, the default value of 1 will be assumed", "format": "int32" }, "childrenCount": { "type": "integer", "description": "In case it is not supplied, the default value of 0 will be assumed", "format": "int32" }, "petCount": { "type": "integer", "description": "In case it is not supplied, the default value of 0 will be assumed", "format": "int32" }, "infantCount": { "type": "integer", "description": "In case it is not supplied, the default value of 0 will be assumed", "format": "int32" }, "riskScore": { "maximum": 100, "minimum": 0, "type": "integer", "description": "Declared departure datetime in property's timezone by the guest on the pre arrival form.", "format": "int32" }, "email": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "secondaryEmail": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "phoneNumber": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "cellPhoneNumber": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "flightNumber": { "type": "string" }, "reasonForTrip": { "type": "string" }, "willHaveParty": { "type": "boolean" }, "willHaveVisit": { "type": "boolean" }, "preferredCurrency": { "type": "string", "enum": [ "USD", "EUR", "GBP", "CAD", "JPY", "INR", "MYR", "AUD", "KES", "MXN", "HKD", "NZD", "CHF", "BRL", "CLP", "COP", "PEN", "ARS", "UYU", "VEF", "CNY", "THB", "KRW", "IDR", "SGD", "TWD", "AED", "ZAR", "CZK", "DKK", "DOP", "SEK", "BGN", "ILS", "NOK", "RON", "RUB", "PHP", "VND", "HUF", "IKR", "PLN", "PYG", "TRY", "GTQ", "VUV", "JOD", "SAR", "EGP", "TTD", "MAD", "CVE", "BBD", "AWG", "BHD", "NONE" ] }, "preferredLocale": { "type": "object", "properties": { "language": { "type": "string" }, "displayName": { "type": "string" }, "country": { "type": "string" }, "variant": { "type": "string" }, "script": { "type": "string" }, "unicodeLocaleAttributes": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "unicodeLocaleKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "displayLanguage": { "type": "string" }, "displayScript": { "type": "string" }, "displayCountry": { "type": "string" }, "displayVariant": { "type": "string" }, "extensionKeys": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "iso3Language": { "type": "string" }, "iso3Country": { "type": "string" } } }, "arrivalLocalDateTime": { "type": "string", "example": "2026-04-20T11:52:36" }, "departureLocalDateTime": { "type": "string", "example": "2026-04-20T11:52:36" } }, "description": "Ignored for BLOCK type of a lead" }, "LeadApi3SingleResourceResponseLeadApiV3_1Dto": { "type": "object", "properties": { "lead": { "$ref": "#/components/schemas/LeadApiV3_1Dto" } } }, "LeadApiV3AssigneeDto": { "type": "object", "properties": { "uid": { "type": "string" }, "type": { "type": "string", "enum": [ "EMPLOYEE", "OWNER", "AGENT" ] } } }, "LeadApiV3_1Dto": { "type": "object", "properties": { "uid": { "type": "string" }, "propertyUid": { "type": "string" }, "agencyUid": { "type": "string" }, "checkInZonedDateTime": { "type": "string", "description": "Check in datetime with the timezone offset", "format": "date-time" }, "checkOutZonedDateTime": { "type": "string", "description": "Check out datetime with the timezone offset", "format": "date-time" }, "checkInLocalDateTime": { "type": "string", "example": "2026-04-20T11:52:36" }, "checkOutLocalDateTime": { "type": "string", "example": "2026-04-20T11:52:36" }, "status": { "type": "string", "enum": [ "BLOCKED", "NEW", "ON_HOLD", "CLOSED", "PENDING", "PENDING_APPROVED", "DECLINED", "BOOKED", "CANCELLED", "IGNORED", "DUPLICATE", "SAMPLE" ] }, "type": { "type": "string", "enum": [ "INQUIRY", "BOOKING_REQUEST", "BLOCK", "BOOKING" ] }, "source": { "type": "string", "enum": [ "HOSTFULLY_UI", "HOSTFULLY_DBS", "HOSTFULLY_API", "HOSTFULLY_LINKED", "HOSTFULLY_OWNER_PORTAL", "HOSTFULLY_ICAL", "DIRECT_HOMETOGO", "DIRECT_BOOKINGDOTCOM", "DIRECT_AIRBNB", "DIRECT_VRBO", "DIRECT_HVMI", "DIRECT_REDAWNING", "DIRECT_GOOGLE" ] }, "channel": { "type": "string", "description": "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", "enum": [ "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" ] }, "bookedUtcDateTime": { "type": "string", "example": "2026-04-20T11:52:36" }, "externalBookingId": { "type": "string" }, "notes": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "extraNotes": { "type": "string", "description": "Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information" }, "assignee": { "$ref": "#/components/schemas/LeadApiV3AssigneeDto" }, "metadata": { "$ref": "#/components/schemas/LeadMetadataApiV3Dto" }, "guestInformation": { "$ref": "#/components/schemas/LeadGuestInformationForCreationApiV3Dto" }, "referrer": { "type": "string" }, "unitUid": { "type": "string" } } }, "LeadMetadataApiV3Dto": { "type": "object", "properties": { "createdUtcDateTime": { "type": "string", "example": "2026-04-20T11:52:36" }, "updatedUtcDateTime": { "type": "string", "example": "2026-04-20T11:52:36" }, "creationCircumstances": { "type": "string", "description": "Optional type defining what process created the lead.", "enum": [ "IMPORTED_FROM_CSV", "CREATED_WHILE_CHANNEL_ON", "IMPORTED_UPON_CHANNEL_CONNECTION" ] } } } }, "securitySchemes": { "JWT-Authentication": { "type": "apiKey", "description": "OAuth Access Token", "name": "Authorization", "in": "header" }, "Agency-API-key": { "type": "apiKey", "description": "API Key", "name": "X-HOSTFULLY-APIKEY", "in": "header" } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 105, "1": 224, "2": 200, "3": 46, "4": 203, "5": 214, "6": 155, "7": 54, "8": 243, "9": 179, "10": 137, "11": 100 } } } ```