Messages
Emails and text messages, scheduled or sent to guests
The message object
Attributes
iduuidUnique identifier
message_template_iduuid | nullIdentifier of the message template the message is based on
created_atread-onlytimestamp with time zoneCreation timestamp
attachmentsArray<MessageAttachment> | nullAttachments included in the email
bodytextBody of the message
htmltext | nullHTML of the email
include_booking_detailsbooleanWhether the message includes booking details
include_booking_linkbooleanWhether the message includes a link to the guest page
include_ical_databooleanWhether the email includes an iCal attachment
include_product_imagebooleanWhether the email includes an image of the unit
include_transactionsbooleanWhether the message includes the booking's transactions
send_attimestamp with time zoneTimestamp at which the message is or was sent
statusMessageStatusStatus of the message
subjecttextSubject of the email
typeMessageTypeType of the message: email or sms
Related resources
Embed related resources in the response with the select parameter, for example select=*,bookings(*). Resources related through more than one column need the column as a hint, like table!column(*).
message_templates(*)object | nullThe message template referenced by message_template_id.
message_events(*)arrayThe message events referencing this message through message_events.message_id.
{
"id": "00000000-0000-0000-0000-000000000000",
"booking_id": "00000000-0000-0000-0000-000000000000",
"message_template_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2026-10-30T22:27:57.301Z",
"attachments": [
{
"filename": "file",
"url": "https://example.com",
"type": "application/pdf"
}
],
"body": "A short description.",
"html": "",
"include_booking_details": false,
"include_booking_link": false,
"include_ical_data": false,
"include_product_image": false,
"include_transactions": false,
"send_at": "2026-10-30T22:27:57.301Z",
"status": "sent",
"subject": "Summer cottage",
"type": "email"
}curl -X GET "https://api.bookingmood.com/v1/messages?limit=10&select=*,bookings(*),message_templates(*)" \
-H "Authorization: Bearer YOUR_API_KEY"List messages
Filters
idFilter<uuid>Unique identifier
message_template_idFilter<uuid | null>Identifier of the message template the message is based on
created_atFilter<timestamp with time zone>Creation timestamp
attachmentsFilter<Array<MessageAttachment> | null>Attachments included in the email
bodyFilter<text>Body of the message
htmlFilter<text | null>HTML of the email
include_booking_detailsFilter<boolean>Whether the message includes booking details
include_booking_linkFilter<boolean>Whether the message includes a link to the guest page
include_ical_dataFilter<boolean>Whether the email includes an iCal attachment
include_product_imageFilter<boolean>Whether the email includes an image of the unit
include_transactionsFilter<boolean>Whether the message includes the booking's transactions
send_atFilter<timestamp with time zone>Timestamp at which the message is or was sent
statusFilter<MessageStatus>Status of the message
subjectFilter<text>Subject of the email
typeFilter<MessageType>Type of the message: email or sms
Responses
200A list of messages with the selected columns
206Partial Content
400The request is malformed, for example an unknown column or an invalid filter.
401The API key is missing or invalid.
code, message, details and hint. See the introduction for more on errors.GET /messagescurl -X GET "https://api.bookingmood.com/v1/messages?select=*&limit=10" \
-H "Authorization: Bearer YOUR_API_KEY"[
{
"id": "00000000-0000-0000-0000-000000000000",
"booking_id": "00000000-0000-0000-0000-000000000000",
"message_template_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2026-10-30T22:27:57.301Z",
"attachments": [
{
"filename": "file",
"url": "https://example.com",
"type": "application/pdf"
}
],
"body": "A short description.",
"html": "",
"include_booking_details": false,
"include_booking_link": false,
"include_ical_data": false,
"include_product_image": false,
"include_transactions": false,
"send_at": "2026-10-30T22:27:57.301Z",
"status": "sent",
"subject": "Summer cottage",
"type": "email"
}
]