API changelog for June, July and August of 2024

Jul 2024

Contract updates

• Leads endpoint
  • Added new action /mark-paf-completed to marks the lead's pre-arrival-form as completed**
• Webhooks endpoint
  • For partners, affiliateID (as objectUid) is no longer required to register webhooks
  • Webhook is unique on set of (creatorIdentifier, objectUid, eventType, url)

API changelog for April, May and June of 2024

Apr 2024 - Sunset of API Version 1

Sunset of API Version 1

• With the introduction of v3 (doc Getting Started with the Hostfully API 3.0), API v1 has been deprecated and will no longer be supported. Please migrate to the latest version to ensure uninterrupted service.

Contract updates

• Services endpoints now return serviceProviderUid
• Properties
  • PATCH endpoint: Provides ability to partially update property resource. Not all fields need to be present
  • New booking strategies supported
    • hostfullyBookingStrategy
    • airbnbBookingStrategy
    • vrboBookingStrategy
• Leadsendpoints
  • Reintroduced referrer field

Jun 2024

Contract updates

• Webhooks endpoint
  • Webhook can't be duplicated with the same set of (creatorIdentifier, objectUid, eventType, url)

API changelog for January, February and March of 2024

Mar 2024 - Introducing tags API for properties and leads

New Feature: Tags API

We're excited to announce the release of the Tags API as part of Hostfully API V3.0. This new feature empowers users to better organize and manage their properties and leads through custom tags.

Key Features:

• Retrieve and Create Tags: Users can now retrieve existing tags and create custom tags for properties and leads via the Tags API.

• Visibility: Tags applied to properties are now visible to Property Managers (PMs) in the property list page, enhancing property organization and identification. Similarly, tags assigned to leads are visible within the lead modal, providing a more streamlined lead management experience.

• Webhooks: Update to property's tag also trigger UPDATED_PROPERTY webhook if exists.

Updated contracts

• Pricing Periods& Pricing Periods Bulk:
  • minimumStay, isCheckinAllowed & isCheckoutAllowed are now optional fields

Due to the incoming release of Hostfully's new Inbox, which implies variety of internal changes, Hostfully will change messaging oriented endpoints.
The endpoints were identified as barely used, therefore we expect the impact on our partners to be minimal.

The following changes are gonna take place effective June 30th 2021:

We will turn off the following endpoints in v1:
GET v1/messages/:uid
GET v1/threads
POST v1/messages

We also want to notify about a contract change of the v2 API regarding messaging:

Currently existing endpoints in v2:
GET v2/messages?threadUid
GET v2/threads?leadUid
GET v2/threads/:uid

will be re-introduced with completely new contract and underyling logic.
The ownership of thread changes from lead to agency, meaning API clients will no longer be able to search for threads by leads.
The approach in the new messaging will be oriented around people communication, not a particular lead. There will be a way of querying leads <> theads binding, which is a transistive relation through guests.

What should partners do?
We did not identify any partner who would use messaging constantly.

If messaging is not a critical part of the integration or you are in the process of implementing it, please wait for the exact new contract to be announced. We presume it is going to happen in the last week of June.

However, if it is critical for your integration and you are currently heavily relying on messaging, then please reserve time for migration to the new contract at the end of June and let us know through email: [email protected].

New lead field and beta functionality

As of October 7 2020, we're introducing BETA functionality that allows modifying the leads through API v2. Currently it's available only in sandbox environment.

As a result, the model for Lead changes new field (enum) is introduced - LeadType{BLOCK,INQUIRY,BOOKING}.

The Lead model is being changed also in V2 in production environment.

Feel free to review leads documentation for v2 under https://dev.hostfully.com/v2.0/reference#leads-get for more details.