API Reference

V3.2 - Messaging Update

Context

The Hostfully PMP is evolving its messaging model architecture to better align with the needs of property managers and enhance communication efficiency. We are introducing a thread-per-reservation model, a significant shift from the existing thread-per-guest approach. This new model organizes messaging threads by individual reservations rather than grouping them under a single guest. It allows for clearer, more context-specific communication, especially for guests with multiple bookings or complex itineraries.

To support this enhanced structure, we’re also launching API v3.2, which brings new functionality and flexibility to our messaging capabilities. The updated API includes features such as the ability to fetch messages tied directly to reservation IDs, and improved integration possibilities for external platforms. With this upgrade, property managers can streamline guest interactions, automate reservation-specific messages, and gain greater control over their communication workflows.

This change not only simplifies messaging management but also lays the groundwork for additional features and improvements in the future, ensuring a more robust and scalable communication system for all users.

What are the changes to the API?

1. Updated URI

Base URL: https://sandbox-api.hostfully.com/api/v3.2/

2. Changes to Existing Endpoints

Messages Endpoint: https://sandbox.hostfully.com/api/v3.2/messages

  • Model Update:
    • The response now includes the senderType field.
    • The response now includes the attachments field.
  • New Capabilities: Messages can now be sent using leadUid or threadUid.

3. New Endpoints

4. Webhooks Update

  • The payload for the NEW_INBOX_MESSAGE webhook now includes these additional fields:
    • message_content, message_uid, lead_uid, thread_uid, created, property_uid, type, status.

How to upgrade to API 3.2

Please refer to this guide for migrating to API 3.2.