2024 Archives

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

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
• Leads endpoints
  • Reintroduced referrer field

Jun 2024

Contract updates

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

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)

Oct 2024

New Features

• Multi unit released. More details in V3.1 - Multi Units
• Introduced multi-unit related endpoints, including Multi-Unit Properties, Unit types and Units

Nov 2024

New Features

• Introduced V3.2 - Messaging Updates with new Threads endpoint, updates on Messages and Messaging Webhooks
  • Threads endpoint:
  • GET /threads by agencyUid, leadUid
  • GET /threads/:uid by threadUid

Updated contracts

• Messages
  • GET /messages by agencyUid, threadUid, leadUid
  • GET /messages/uid: by messageUid
  • Added senderType to the response
  • Add filter by createdAt (from certain timestamp)
  • POST /messages/:uid/resend: action to resend message
• Webhooks for NEW_INBOX_MESSAGE
  • Added
    • threadUid → thread_uid
    • leadUid → lead_uid
    • messageUid → message_uid
    • status → status
    • channel → type
    • content → message_content
    • senderType → sender_type
    • createdTime → created