--- title: "Create a new lead" method: POST path: "/api/v3.3/leads" tags: ["Leads"] --- # Create a new lead `POST /api/v3.3/leads` Creates given lead in the system. For further lead workflow interactions, please use resource actions available under POST .../leads/{uid}/{action} .Api client creating lead will have access to that lead's personal and confidential information. ## Request body - LeadApiV31CreationDto — Requires either pair of (checkInLocalDateTime, checkOutLocalDateTime) or (checkInLocalDate, checkOutLocalDate) - `propertyUid` string, required - `agencyUid` string, required - `checkInLocalDateTime` string - `checkOutLocalDateTime` string - `checkInLocalDate` string, date — Check in date. For specifying time, use checkInLocalDateTime. - `checkOutLocalDate` string, 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 - `guestInformation` LeadGuestInformationForCreationApiV3Dto — Ignored for BLOCK type of a lead - `firstName` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `lastName` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `address1` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `address2` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `zipCode` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `city` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `state` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `countryCode` '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' — Replaced with null if api caller has no access to see lead's personal and confidential information - `passportId` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `passportCountryCode` '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' — Replaced with null if api caller has no access to see lead's personal and confidential information - `adultCount` integer — In case it is not supplied, the default value of 1 will be assumed - `childrenCount` integer — In case it is not supplied, the default value of 0 will be assumed - `petCount` integer — In case it is not supplied, the default value of 0 will be assumed - `infantCount` integer — In case it is not supplied, the default value of 0 will be assumed - `riskScore` integer — Declared departure datetime in property's timezone by the guest on the pre arrival form. - `email` string, required — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `secondaryEmail` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `phoneNumber` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `cellPhoneNumber` string — Replaced with 'HIDDEN' if api caller has no access to see lead's personal and confidential information - `flightNumber` string - `reasonForTrip` string - `willHaveParty` boolean - `willHaveVisit` boolean - `preferredCurrency` '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` object - `language` string - `displayName` string - `country` string - `variant` string - `script` string - `unicodeLocaleAttributes` string[] - `unicodeLocaleKeys` string[] - `displayLanguage` string - `displayScript` string - `displayCountry` string - `displayVariant` string - `extensionKeys` string[] - `iso3Language` string - `iso3Country` string - `arrivalLocalDateTime` string - `departureLocalDateTime` string - `bookedUtcDateTime` string - `externalBookingId` string — Ignored for BLOCK type of a lead - `notes` string - `extraNotes` string - `quoteOverrides` QuoteOverridesApi3Dto - `rent` QuoteRentOverridesApi3Dto - `rentBaseNetPrice` number - `rentNetPrice` number - `extraGuestsNetPrice` number - `taxationRate` number - `taxAmount` number - `extraGuestsBaseNetPrice` number - `securityDeposit` number - `fees` QuoteFeesOverridesApi3Dto - `cleaningFee` PriceOverridesApi3Dto - `netPrice` number, required - `taxationRate` number - `otherFees` QuoteFeeOverridesApi3Dto[] - `feeId` integer - `feeUid` string - `name` string - `amountType` 'AMOUNT' | 'TAX' - `amount` number - `taxationRate` number - `scope` 'PER_NIGHT' | 'PER_STAY' | 'PER_GUEST_PER_NIGHT' | 'PER_GUEST' | 'PER_PET' | 'PER_PET_PER_NIGHT' | 'PERCENTAGE_OF_TOTAL' | 'PERCENTAGE_OF_RENT' - `type` 'CLEANING' | 'EARLY_ARRIVAL' | 'LATE_DEPARTURE' | 'PET' | 'TAX' | 'CUSTOM' - `isOptional` boolean - `netPrice` number - `enabled` boolean - `removed` boolean - `totalPrice` number - `force100PercentPaymentAtReservation` boolean - `referrer` string - `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 - `unitUid` string — Required when 'propertyUid' filed is a uid of a Unit Type. ## Response `200` OK --- [API](https://skmtc.dev/hostfully/apis/hostfully-api.md) · [All operations](https://skmtc.dev/hostfully/apis/hostfully-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hostfully/hostfully-api/revisions/8387ad22afc6/schema)