Servers Playground How we check Add a server Log in

Hostfully MCP by usefulapi

Working · 541 ms

io.usefulapi/hostfullyv1.21.0 Domain verified

Check properties, calendars, leads, quotes, guests and messages in Hostfully, and send replies.

Maps & Travel

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://hostfully.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

hostfully_calculate_quote Read-only

Price a prospective stay at one property: rent, fees, taxes, security deposit and total for the given dates and party. Computes only — creates nothing. Hostfully: POST /api/v3.3/quotes.

guestsinteger, required

Number of guests.

property_uidstring, required

The property's UID.

check_in_datestring, required

Check-in date (YYYY-MM-DD).

check_out_datestring, required

Check-out date (YYYY-MM-DD).

lead_uidstring

Quote in the context of an existing lead.

pet_countinteger

Number of pets.

agency_uidstring

Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.

children_countinteger

Children among the guests.

Hostfully MCP by usefulapi MCP server | mcptry

Tools (20)

hostfully_calculate_quote

Price a prospective stay at one property: rent, fees, taxes, security deposit and total for the given dates and party. Computes only — creates nothing. Hostfully: POST /api/v3.3/quotes.

read-only

Argument	Type	Description
guests*	integer	Number of guests.
lead_uid	string	Quote in the context of an existing lead.
pet_count	integer	Number of pets.
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.
property_uid*	string	The property's UID.
check_in_date*	string	Check-in date (YYYY-MM-DD).
check_out_date*	string	Check-out date (YYYY-MM-DD).
children_count	integer	Children among the guests.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "property_uid",
    "check_in_date",
    "check_out_date",
    "guests"
  ],
  "properties": {
    "guests": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 1,
      "description": "Number of guests."
    },
    "lead_uid": {
      "type": "string",
      "description": "Quote in the context of an existing lead."
    },
    "pet_count": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Number of pets."
    },
    "agency_uid": {
      "type": "string",
      "description": "Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options."
    },
    "property_uid": {
      "type": "string",
      "description": "The property's UID."
    },
    "check_in_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Check-in date (YYYY-MM-DD)."
    },
    "check_out_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Check-out date (YYYY-MM-DD)."
    },
    "children_count": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Children among the guests."
    }
  }
}

hostfully_create_job

Schedule a job (e.g. a cleaning or a guest greeting) for a service at a property, optionally tied to a lead. Times are property-local. hostfully_list_services gives the service UID. Hostfully: POST /api/v3.3/jobs.

destructive

Argument	Type	Description
end*	string	End, YYYY-MM-DDTHH:MM:SS.
notes	string
start*	string	Start, YYYY-MM-DDTHH:MM:SS.
status	string	Initial status; default NEW.
lead_uid	string	The booking this job serves.
service_uid*	string	The service's UID.
property_uid*	string	The property's UID.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "property_uid",
    "service_uid",
    "start",
    "end"
  ],
  "properties": {
    "end": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
      "description": "End, YYYY-MM-DDTHH:MM:SS."
    },
    "notes": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
      "description": "Start, YYYY-MM-DDTHH:MM:SS."
    },
    "status": {
      "enum": [
        "NEW",
        "SCHEDULED"
      ],
      "type": "string",
      "description": "Initial status; default NEW."
    },
    "lead_uid": {
      "type": "string",
      "description": "The booking this job serves."
    },
    "service_uid": {
      "type": "string",
      "description": "The service's UID."
    },
    "property_uid": {
      "type": "string",
      "description": "The property's UID."
    }
  }
}

hostfully_create_lead

Create a lead at one property: status BLOCKED puts an owner/maintenance block on the calendar; status NEW records a guest inquiry (which does not confirm a booking or take payment). Blocks can later be removed in Hostfully; inquiries go through the normal pipeline. Dates are local to the property. Hostfully: POST /api/v3.3/leads.

destructive

Argument	Type	Description
guest	object	Guest information — needed for an inquiry, usually omitted for a block.
notes	string	Notes on the lead.
status*	string	BLOCKED = calendar block, NEW = inquiry.
check_in*	string	Check-in, property-local, YYYY-MM-DDTHH:MM:SS.
check_out*	string	Check-out, property-local, YYYY-MM-DDTHH:MM:SS.
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.
property_uid*	string	The property's UID.
external_booking_id

hostfully_get_lead

Fetch one lead (booking, inquiry, booking request or block) by UID — status, channel, dates, guest information, notes and assignee. Hostfully: GET /api/v3.3/leads/{leadUid}.

read-only

Argument	Type	Description
lead_uid*	string	The lead's UID.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lead_uid"
  ],
  "properties": {
    "lead_uid": {
      "type": "string",
      "description": "The lead's UID."
    }
  }
}

hostfully_get_pricing_periods

The nightly price, minimum stay and check-in/check-out availability set for each date of one property over a range. Hostfully: GET /api/v3.3/pricing-periods.

read-only

Argument	Type	Description
to*	string	Last day (YYYY-MM-DD).
from*	string	First day (YYYY-MM-DD).
property_uid*	string	The property's UID.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "property_uid",
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Last day (YYYY-MM-DD)."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "First day (YYYY-MM-DD)."
    },
    "property_uid": {
      "type": "string",
      "description": "The property's UID."
    }
  }
}

hostfully_get_property

Fetch one property's full details — address, time zone, rooms, pricing and availability settings, channel data, booking notes and cancellation policy. Hostfully: GET /api/v3.3/properties/{propertyUid}.

read-only

Argument	Type	Description
property_uid*	string	The property's UID.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "property_uid"
  ],
  "properties": {
    "property_uid": {
      "type": "string",
      "description": "The property's UID."
    }
  }
}

hostfully_get_property_calendar

Day-by-day availability and pricing for one property over a date range — the direct answer to 'is it free, and at what price?'. Hostfully: GET /api/v3.3/property-calendar/{propertyUid}.

read-only

Argument	Type	Description
to*	string	Last day (YYYY-MM-DD).
from*	string	First day (YYYY-MM-DD).
property_uid*	string	The property's UID.
availability_comments	boolean	Include availability comments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "property_uid",
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Last day (YYYY-MM-DD)."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "First day (YYYY-MM-DD)."
    },
    "property_uid": {
      "type": "string",
      "description": "The property's UID."
    },
    "availability_comments": {
      "type": "boolean",
      "description": "Include availability comments."
    }
  }
}

hostfully_list_agencies

List the agencies this API key can access, with their UIDs, currency and default check-in/out times. Start here to find the agency_uid other tools need. Hostfully: GET /api/v3.3/agencies.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

hostfully_list_guests

List the agency's guest records — names, email, phone, address and profile notes. Hostfully: GET /api/v3.3/guests/{agencyUid}.

read-only

Argument	Type	Description
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "agency_uid": {
      "type": "string",
      "description": "Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options."
    }
  }
}

hostfully_list_jobs

List operational jobs (cleanings, greetings, maintenance and other services) scheduled in a date window, optionally for given properties and statuses, sorted by start date. Hostfully: GET /api/v3.3/jobs.

read-only

Argument	Type	Description
to*	string	Window end (YYYY-MM-DD).
from*	string	Window start (YYYY-MM-DD).
statuses	array	Only jobs in these statuses.
property_uids	array	Only jobs at these properties.
modified_since	string	Only jobs modified on or after this date; Hostfully requires it, default 2000-01-01 (YYYY-MM-DD).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Window end (YYYY-MM-DD)."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Window start (YYYY-MM-DD)."
    },
    "statuses": {
      "type": "array",
      "items": {
        "enum": [
          "NEW",
          "SCHEDULED",
          "DONE",
          "CANCELLED"
        ],
        "type": "string"
      },
      "description": "Only jobs in these statuses."
    },
    "property_uids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Only jobs at these properties."
    },
    "modified_since": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Only jobs modified on or after this date; Hostfully requires it, default 2000-01-01 (YYYY-MM-DD)."
    }
  }
}

hostfully_list_messages

Read guest messages (Airbnb, VRBO, Booking.com, email, SMS, WhatsApp, in-app) for a lead, a thread or a whole agency, with sender type, status and content. Give lead_uid, thread_uid, or agency_uid (or the default). Cursor-paginated. Hostfully: GET /api/v3.3/messages.

read-only

Argument	Type	Description
limit	integer	Page size, 1-100.
cursor	string	Cursor from the previous page's _paging._nextCursor. Omit for the first page.
lead_uid	string	Only messages about this lead.
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.
created_at	string	Creation-date filter, ISO date-time, e.g. 2026-04-20T11:52:36Z.
thread_uid	string	Only messages in this thread.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Page size, 1-100."
    },
    "cursor": {
      "type": "string",
      "description": "Cursor from the previous page's _paging._nextCursor. Omit for the first page."
    },
    "lead_uid": {
      "type": "string",
      "description": "Only messages about this lead."
    },
    "agency_uid": {
      "type": "string",
      "description": "Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options."
    },
    "created_at": {
      "type": "string",
      "description": "Creation-date filter, ISO date-time, e.g. 2026-04-20T11:52:36Z."
    },
    "thread_uid": {
      "type": "string",
      "description": "Only messages in this thread."
    }
  }
}

hostfully_list_orders

List orders — the money side of a booking: rent, fees, services, adjustments, taxes, channel commission and total. Filter by lead, property, guest or update time (at least one is required). Hostfully: GET /api/v3.3/orders.

read-only

Argument	Type	Description
lead_uid	string	Only the order of this lead.
guest_uid	string	Only orders of this guest.
property_uid	string	Only orders for this property.
updated_since	string	Only records updated since this UTC time, e.g. 2026-04-20T11:52:36.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "lead_uid": {
      "type": "string",
      "description": "Only the order of this lead."
    },
    "guest_uid": {
      "type": "string",
      "description": "Only orders of this guest."
    },
    "property_uid": {
      "type": "string",
      "description": "Only orders for this property."
    },
    "updated_since": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
      "description": "Only records updated since this UTC time, e.g. 2026-04-20T11:52:36."
    }
  }
}

hostfully_list_owners

List the agency's property owners — contact details, business name, commission rate and permissions — optionally filtered by a search string. Hostfully: GET /api/v3.3/owners.

read-only

Argument	Type	Description
query	string	Free-text search over owners.
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "query": {
      "type": "string",
      "description": "Free-text search over owners."
    },
    "agency_uid": {
      "type": "string",
      "description": "Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options."
    }
  }
}

hostfully_list_properties

List an agency's properties (rentals) with name, address, type, bedrooms, active flag and pricing/availability settings. Cursor-paginated. Hostfully: GET /api/v3.3/properties.

read-only

Argument	Type	Description
limit	integer	Page size, 1-100.
cursor	string	Cursor from the previous page's _paging._nextCursor. Omit for the first page.
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.
updated_since	string	Only records updated since this UTC time, e.g. 2026-04-20T11:52:36.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Page size, 1-100."
    },
    "cursor": {
      "type": "string",
      "description": "Cursor from the previous page's _paging._nextCursor. Omit for the first page."
    },
    "agency_uid": {
      "type": "string",
      "description": "Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options."
    },
    "updated_since": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
      "description": "Only records updated since this UTC time, e.g. 2026-04-20T11:52:36."
    }
  }
}

hostfully_list_reviews

List guest reviews for a property or a lead — rating, title, content, source, private feedback and the host response. Cursor-paginated. Hostfully: GET /api/v3.3/reviews.

read-only

Argument	Type	Description
sort	string
limit	integer	Page size, 1-100.
cursor	string	Cursor from the previous page's _paging._nextCursor. Omit for the first page.
source	string
lead_uid	string	Reviews tied to this lead.
property_uid	string	Reviews of this property.
updated_since	string	Only records updated since this UTC time, e.g. 2026-04-20T11:52:36.
sort_direction	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sort": {
      "enum": [
        "SORT_BY_RATING",
        "SORT_BY_DATE",
        "SORT_BY_AUTHOR"
      ],
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Page size, 1-100."
    },
    "cursor": {
      "type": "string",
      "description": "Cursor from the previous page's _paging._nextCursor. Omit for the first page."
    },
    "source": {
      "enum": [
        "BOOKING_DOT_COM",
        "VRBO",
        "FACEBOOK",
        "TRIPADVISOR",
        "REVYOOS",
        "HOSTFULLY"
      ],
      "type": "string"
    },
    "lead_uid": {
      "type": "string",
      "description": "Reviews tied to this lead."
    },
    "property_uid": {
      "type": "string",
      "description": "Reviews of this property."
    },
    "updated_since": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
      "description": "Only records updated since this UTC time, e.g. 2026-04-20T11:52:36."
    },
    "sort_direction": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string"
    }
  }
}

hostfully_list_services

List the services an agency offers or schedules (cleaning, transportation, greeting, cooking, tours ...), with provider, price and duration. A service UID is what hostfully_create_job needs. Hostfully: GET /api/v3.3/services.

read-only

Argument	Type	Description
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.
catered_to	string	Who the service is for.
service_provider_uid	string	Only services of this provider.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "agency_uid": {
      "type": "string",
      "description": "Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options."
    },
    "catered_to": {
      "enum": [
        "GUEST",
        "HOST",
        "BOTH"
      ],
      "type": "string",
      "description": "Who the service is for."
    },
    "service_provider_uid": {
      "type": "string",
      "description": "Only services of this provider."
    }
  }
}

hostfully_list_threads

List guest-messaging threads for an agency or one lead, with participants and read status. Give lead_uid, or agency_uid (or the default). Cursor-paginated. Hostfully: GET /api/v3.3/threads.

read-only

Argument	Type	Description
limit	integer	Page size, 1-100.
cursor	string	Cursor from the previous page's _paging._nextCursor. Omit for the first page.
lead_uid	string
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Page size, 1-100."
    },
    "cursor": {
      "type": "string",
      "description": "Cursor from the previous page's _paging._nextCursor. Omit for the first page."
    },
    "lead_uid": {
      "type": "string"
    },
    "agency_uid": {
      "type": "string",
      "description": "Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options."
    }
  }
}

hostfully_search_leads

Search leads — Hostfully's word for bookings, inquiries, booking requests and calendar blocks — by agency, property or UIDs, and by check-in/check-out date. Returns status, type, channel, dates and guest info. Give at least one of agency_uid (or the default), property_uid, or lead_uids. Cursor-paginated. Hostfully: GET /api/v3.3/leads.

read-only

Argument	Type	Description
limit	integer	Page size, 1-100.
cursor	string	Cursor from the previous page's _paging._nextCursor. Omit for the first page.
lead_uids	array	Only these lead UIDs.
agency_uid	string	Agency UID. Defaults to HOSTFULLY_AGENCY_UID; hostfully_list_agencies lists the options.
check_in_to	string	Check-in on or before (YYYY-MM-DD).
check_out_to	string	Check-out on or before (YYYY-MM-DD).
property_uid	string	Only leads for this property.
check_in_from	string	Check-in on or after (YYYY-MM-DD).

hostfully_send_message

Send a message to the guest of a lead, by EMAIL or as a DIRECT_MESSAGE on the booking channel (Airbnb, VRBO or Booking.com leads only). This reaches a real guest and cannot be unsent — confirm the text first. Hostfully: POST /api/v3.3/messages.

destructive

Argument	Type	Description
text*	string	The message body.
type*	string	EMAIL, or DIRECT_MESSAGE via the channel.
subject	string	Subject line (email).
lead_uid*	string	The lead whose guest receives the message.
thread_uid	string	Post into this existing thread.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lead_uid",
    "type",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "minLength": 1,
      "description": "The message body."
    },
    "type": {
      "enum": [
        "EMAIL",
        "DIRECT_MESSAGE"
      ],
      "type": "string",
      "description": "EMAIL, or DIRECT_MESSAGE via the channel."
    },
    "subject": {
      "type": "string",
      "description": "Subject line (email)."
    },
    "lead_uid": {
      "type": "string",
      "description": "The lead whose guest receives the message."
    },
    "thread_uid": {
      "type": "string",
      "description": "Post into this existing thread."
    }
  }
}

hostfully_update_lead

Partially update a lead's notes, extra notes and guest details (name, contact, address, arrival/departure times). Does NOT change dates, party size, property or status. Hostfully may ignore personal-data fields the key is not allowed to edit. Hostfully: PATCH /api/v3.3/leads/{leadUid}.

destructive

Argument	Type	Description
guest	object	Guest fields to change; omitted fields are kept.
notes	string
lead_uid*	string	The lead's UID.
extra_notes	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "lead_uid"
  ],
  "properties": {
    "guest": {
      "type": "object",
      "properties": {
        "city": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "zipCode": {
          "type": "string"
        },
        "address1": {
          "type": "string"
        },
        "address2": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "firstName": {
          "type": "string"
        },
        "countryCode": {
          "type": "string",
          "description": "Two-letter country code, e.g. US."
        },
        "phoneNumber": {
          "type": "string"
        },
        "flightNumber": {
          "type": "string"
        },
        "reasonForTrip": {
          "type": "string"
        },
        "secondaryEmail": {
          "type": "string"
        },
        "cellPhoneNumber": {
          "type": "string"
        },
        "arrivalLocalDateTime": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
          "description": "Expected arrival, YYYY-MM-DDTHH:MM:SS."
        },
        "departureLocalDateTime": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(:\\d{2})?$",
          "description": "Expected departure, YYYY-MM-DDTHH:MM:SS."
        }
      },
      "description": "Guest fields to change; omitted fields are kept."
    },
    "notes": {
      "type": "string"
    },
    "lead_uid": {
      "type": "string",
      "description": "The lead's UID."
    },
    "extra_notes": {
      "type": "string"
    }
  }
}

Input schema (JSON)

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