Core resources


Administration


Booking flow

Emails

Emails scheduled or sent to guests

Endpoints

The email object

Attributes

iduuid

Unique identifier

calendar_event_iduuid | null
calendar_events.id

Identifier of the related calendar event

email_template_iduuid | null
email_templates.id

Identifier of the email template this email is based on

member_iduuid | null
members.id

Identifier of the member that sent the email

created_attimestamp with time zone

Creation timestamp

attachmentsjsonb | null

List of attachments to include in the email

bodytext

Body of the email

htmltext | null

HTML of the email

include_booking_detailsboolean

Whether booking details should be included in the email

include_booking_linkboolean

Whether a link to the booking status page should be included in the email

include_ical_databoolean

Whether an iCal attachment should be included in the email

include_product_imageboolean

Whether a product image should be included in the email

send_attimestamp with time zone

Timestamp at which the email is sent or should be sent

statustext

Status of the email

subjecttext

Subject of the email

templatetext | null

Template of the email

typetext
The email object
{
"id": "00000000-0000-0000-0000-000000000000",
"calendar_event_id": "00000000-0000-0000-0000-000000000000",
"email_template_id": "00000000-0000-0000-0000-000000000000",
"member_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-04-20T03:06:22.001Z",
"attachments": {},
"body": "",
"html": "",
"include_booking_details": false,
"include_booking_link": false,
"include_ical_data": false,
"include_product_image": false,
"send_at": "2024-04-20T03:06:22.001Z",
"status": "sent",
"subject": "",
"template": "",
"type": "email"
}

List emails

Filters

idFilter<uuid>

Unique identifier

calendar_event_idFilter<uuid>

Identifier of the related calendar event

email_template_idFilter<uuid>

Identifier of the email template this email is based on

member_idFilter<uuid>

Identifier of the member that sent the email

created_atFilter<timestamp with time zone>

Creation timestamp

attachmentsFilter<jsonb>

List of attachments to include in the email

bodyFilter<text>

Body of the email

htmlFilter<text>

HTML of the email

include_booking_detailsFilter<boolean>

Whether booking details should be included in the email

include_booking_linkFilter<boolean>

Whether a link to the booking status page should be included in the email

include_ical_dataFilter<boolean>

Whether an iCal attachment should be included in the email

include_product_imageFilter<boolean>

Whether a product image should be included in the email

send_atFilter<timestamp with time zone>

Timestamp at which the email is sent or should be sent

statusFilter<text>

Status of the email

subjectFilter<text>

Subject of the email

templateFilter<text>

Template of the email

typeFilter<text>

Responses

200

A list of emails with the selected columns

206

Partial Content

GET/emails
curl -X GET "https://api.bookingmood.com/v1/emails?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"