Create a new lead

post

https://sandbox-api.hostfully.com/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Requires either pair of (checkInLocalDateTime, checkOutLocalDateTime) or (checkInLocalDate, checkOutLocalDate)

propertyUid

string

required

agencyUid

string

required

checkInLocalDateTime

string

checkOutLocalDateTime

string

checkInLocalDate

date

Check in date. For specifying time, use checkInLocalDateTime.

checkOutLocalDate

date

Check out date. For specifying time, use checkOutLocalDateTime.

status

string

enum

required

guestInformation

object

Ignored for BLOCK type of a lead

bookedUtcDateTime

string

externalBookingId

string

Ignored for BLOCK type of a lead

notes

string

extraNotes

string

quoteOverrides

object

referrer

string

channel

string

enum

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

200OK