Conversation

The Conversation entity is used within the Reservation entity to specify information about the conversation related to the reservation.

Fields

Field	Type	Description
id	string/number	Unique identifier for the conversation thread.
externalThreadId	string/number	Unique identifier for the conversation thread from the respective OTA.
reservationId	string/number	Unique Identifier for the associated reservation.
propertyId	string/number	Identifier for the associated property.
roomId	string/number	Identifier for the associated room or room type, based on the PMS system.
type (*deprecated)	string	Type of the conversation thread.
createdAt	string	Creation date of the conversation thread in ISO 8601 format.
updatedAt	string	Last update date of the conversation in ISO 8601 format.
recipient.name	string	Name of the recipient.
recipient.email	string	Email of the recipient.
recipient.picture	string	Picture of the recipient.
messages.id	string/number	Unique identifier of the message.
messages.createdAt	string	Creation date of the message in ISO 8601 format.
messages.updatedAt	string	Last update date of the message in ISO 8601 format.
messages.body	string	Body of the message.
messages.subject	string	Subject of the message.
messages.senderType	string	Role of the entity sending the message. Possible values include Owner/Guest/Log.
messages.type	string	Type of the message.
messages.status	string	Status of the message.
messages.seenStatus	string	Seen Status of the message.
messages.is_automatic	bool	Indicates if it's a system generated/automated message or not.
messages.attachments.id	string/number	Unique identifier of the attachment within the message.
messages.attachments.url	string	URL of the attachment.
messages.attachments.type.extension	string	File extension of the attachment.
messages.attachments.type.mimeType	string	MIME type of the attachment.

Note:

• type field will be deprecated from the API and webhook payload by 28th March, 2025.
• messages.type and messages.attachments.url are supported for Hostify only in conversation.updated webhooks. They're not supported in API end-points.

ENUMS

SenderType

Owner = "Owner"
Guest = "Guest"
Log = "Log"

messages.type

Email = "EMAIL"
SMS = "SMS"
WHATSAPP = "WHATSAPP"
CHANNEL = "CHANNEL"
MESSENGER = "MESSENGER"
UNKOWN = "UNKNOWN"

seenStatus

SEEN = "SEEN"
UNSEEN = "UNSEEN"
UNKOWN = "UNKNOWN"

Status

CREATED = "CREATED"
PENDING = "PENDING"
SENT = "SENT"
DELIVERED = "DELIVERED"
FAILED = "FAILED"

Supported fields in each source system:

Field	Hostfully	Guesty	Hostaway	Lodgify	Hostify	OwnerRez	BookingSync	Beds24	Hospitable	Resly	Smoobu	FantasticStay	Your.Rentals	Hostex	RentalWise
id	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
externalThreadId	-	✅	✅	-	✅	-	-	-	-	-	-	-	🔜	🔜	✅
reservationId	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
propertyId	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
roomId	-	-	-	✅	-	-	-	✅	-	✅	-	-	🔜	🔜	-
createdAt	🔜	✅	-	-	-	-	✅	-	-	-	-	-	🔜	🔜	✅
updatedAt	-	✅	✅	✅	✅	-	✅	-	-	-	-	✅	🔜	🔜	✅
type	✅	✅	✅	✅	-	✅	✅	✅	✅	-	-	-	🔜	✅	✅
recipient.name	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
recipient.email	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
recipient.phone	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
recipient.picture	-	🔜	✅	-	-	-	-	-	✅	-	✅	-	🔜	🔜	-
messages.id	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
messages.createdAt	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
messages.updatedAt	-	-	✅	-	-	-	✅	-	-	-	-	-	🔜	🔜	✅
messages.body	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
messages.subject	✅	✅	✅	✅	-	✅	🔜	-	-	✅	✅	-	🔜	🔜	✅
messages.type	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	-	-	🔜	✅	✅
messages.attachments.id	✅	✅	✅	-	-	-	🔜	-	-	-	-	🔜	🔜	🔜	-
messages.attachments.name	✅	✅	✅	✅	-	-	🔜	✅	-	-	-	🔜	🔜	🔜	-
messages.attachments.url	✅	✅	✅	✅	-	-	🔜	✅	✅	-	-	🔜	🔜	✅	-
messages.attachments.type.extension	✅	🔜	✅	✅	-	-	🔜	-	-	-	-	-	🔜	🔜	-
messages.attachments.type.mimeType	✅	🔜	✅	🔜	-	-	🔜	✅	✅	-	-	-	🔜	🔜	-
messages.status	✅	✅	✅	✅	-	-	-	-	-	-	-	-	🔜	🔜	✅
messages.senderType	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅	🔜	✅	✅
messages.seenStatus	-	🔜	✅	✅	-	-	-	✅	-	-	-	-	🔜	🔜	✅
messages.is_automatic	-	✅	✅	-	✅	-	🔜	-	-	-	-	-	🔜	🔜	-

✅ Supported and mapped
🔶 Partially mapped, not exact match
🔜 Launching soon
— Not supported in source system

Supported Methods in each source system

Methods	Hostaway	Hostify	Smoobu	Lodgify	Uplisting	Guesty	Hostfully	OwnerRez	Beds24	Hospitable	FantasticStay	Hostex	BookingSync	Resly	RentalWise
Get Conversations	✅	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅
Get a Conversation	✅	✅	✅	✅	-	✅	-	✅	✅	✅	✅	✅	✅	✅	✅
Create Conversation message	✅	✅	✅	✅	-	✅	✅	✅	✅	✅	✅	✅	✅	✅	✅

Sample Response

{
    "success": true,
    "data": [
        {
            "id": "12345678",
            "externalThreadId": "87654321",
            "reservationId": "11223344",
            "propertyId": "55667788",
            "type": "DIRECT",
            "recipient": {
                "name": "Alex Johnson",
                "email": null,
                "phone": "",
                "picture": "https://example.com/images/profile_placeholder.jpg"
            },
            "updatedAt": "2025-01-13T23:37:53",
            "messages": [
                {
                    "id": "99887766",
                    "body": "Thanks, you as well!",
                    "senderType": "Guest",
                    "createdAt": "2025-01-13T23:40:49",
                    "updatedAt": "2025-01-13T23:40:49",
                    "status": "SENT",
                    "seenStatus": "UNSEEN",
                    "attachments": [],
                    "type": "CHANNEL",
                    "isAutomatic": false,
                    "subject": ""
                },
                {
                    "id": "88776655",
                    "body": "Ok great! We look forward to hosting you. Have wonderful 2025 :)",
                    "senderType": "Owner",
                    "createdAt": "2025-01-13T23:37:53",
                    "updatedAt": "2025-01-13T23:37:55",
                    "status": "SENT",
                    "seenStatus": "SEEN",
                    "attachments": [
                        {
                            "id": "12345",
                            "name": "booking-confirmation.jpeg",
                            "url": "https://example.com/attachments/booking-confirmation.jpeg",
                            "type": {
                                "mimeType": "image/jpeg"
                            }
                        }
                    ],
                    "type": "CHANNEL",
                    "isAutomatic": false,
                    "subject": ""
                },
                {
                    "id": "77665544",
                    "body": "Yes, it is for next year in 2026.",
                    "senderType": "Guest",
                    "createdAt": "2025-01-13T23:33:02",
                    "updatedAt": "2025-01-13T23:33:02",
                    "status": "SENT",
                    "seenStatus": "UNSEEN",
                    "attachments": [],
                    "type": "CHANNEL",
                    "isAutomatic": false,
                    "subject": ""
                },
                {
                    "id": "66554433",
                    "body": "Hi Alex, I just noticed your reservation is for 2026 is this correct? I just wanted to make sure because we are booked for those days this year.",
                    "senderType": "Owner",
                    "createdAt": "2025-01-13T23:25:51",
                    "updatedAt": "2025-01-13T23:25:53",
                    "status": "SENT",
                    "seenStatus": "SEEN",
                    "attachments": [],
                    "type": "CHANNEL",
                    "isAutomatic": false,
                    "subject": ""
                },
                {
                    "id": "55443322",
                    "body": "Hi Alex, thank you for choosing our house. We hope you enjoy your stay.",
                    "senderType": "Owner",
                    "createdAt": "2025-01-13T22:17:51",
                    "updatedAt": "2025-01-13T22:17:53",
                    "status": "SENT",
                    "seenStatus": "SEEN",
                    "attachments": [],
                    "type": "CHANNEL",
                    "isAutomatic": false,
                    "subject": ""
                },
                {
                    "id": "44332211",
                    "body": "Hi! The home is lovely and the location seems great. My husband, dog and I will be working remotely and exploring Austin. \n\nThanks,\nAlex",
                    "senderType": "Guest",
                    "createdAt": "2025-01-13T22:15:41",
                    "updatedAt": "2025-01-13T22:15:41",
                    "status": "SENT",
                    "seenStatus": "UNSEEN",
                    "attachments": [],
                    "type": "CHANNEL",
                    "isAutomatic": false,
                    "subject": ""
                }
            ]
        }
    ]
}