Core resources


Administration


Booking flow

Email templates

Re-usable email templates

The email template object

Attributes

iduuid

Unique identifier

organization_iduuid

Identifier of the organization this email template is defined in

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

attachmentsjsonb

List of attachments to include in the email

bodyjsonb

Body of the email

ftstsvector

Full text search index

include_booking_detailsboolean

Whether to include booking details in the email

include_booking_linkboolean

Whether to include a link to the booking status page in the email

include_ical_databoolean

Whether to include an iCal attachment in the email

include_product_imageboolean

Whether to include a product image in the email

momentjsonb | null

Moment at which the email should be sent. Formatted as { type: "check-in" | "checkout" | "confirmation" | "on-site" | "request", offset: integer }

past_schedule_behaviortext
status"CANCELLED" | "TENTATIVE" | "CONFIRMED"
subjectjsonb

Subject of the email

timetime without time zone | null
triggertext | null

Trigger of the email template

typetext
The email template object
{
"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-10-05T00:42:39.795Z",
"updated_at": "2024-10-05T00:42:39.795Z",
"attachments": {},
"body": {},
"include_booking_details": false,
"include_booking_link": true,
"include_ical_data": false,
"include_product_image": false,
"moment": {},
"past_schedule_behavior": "skip",
"status": "CONFIRMED",
"subject": {},
"time": null,
"trigger": "",
"type": "email"
}

List email templates

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this email template is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

attachmentsFilter<>

List of attachments to include in the email

bodyFilter<>

Body of the email

ftsFilter<>

Full text search index

include_booking_detailsFilter<>

Whether to include booking details in the email

include_booking_linkFilter<>

Whether to include a link to the booking status page in the email

include_ical_dataFilter<>

Whether to include an iCal attachment in the email

include_product_imageFilter<>

Whether to include a product image in the email

momentFilter<>

Moment at which the email should be sent. Formatted as { type: "check-in" | "checkout" | "confirmation" | "on-site" | "request", offset: integer }

past_schedule_behaviorFilter<>
statusFilter<>
subjectFilter<>

Subject of the email

timeFilter<>
triggerFilter<>

Trigger of the email template

typeFilter<>

Responses

200

A list of email templates with the selected columns

206

Partial Content

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

Create email templates

Body

Partial<EmailTemplate>
| Array<Partial<EmailTemplate>>

Responses

201

The newly created email templates with the selected columns

POST/email_templates
curl -X POST "https://api.bookingmood.com/v1/email_templates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete email templates

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this email template is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

attachmentsFilter<>

List of attachments to include in the email

bodyFilter<>

Body of the email

ftsFilter<>

Full text search index

include_booking_detailsFilter<>

Whether to include booking details in the email

include_booking_linkFilter<>

Whether to include a link to the booking status page in the email

include_ical_dataFilter<>

Whether to include an iCal attachment in the email

include_product_imageFilter<>

Whether to include a product image in the email

momentFilter<>

Moment at which the email should be sent. Formatted as { type: "check-in" | "checkout" | "confirmation" | "on-site" | "request", offset: integer }

past_schedule_behaviorFilter<>
statusFilter<>
subjectFilter<>

Subject of the email

timeFilter<>
triggerFilter<>

Trigger of the email template

typeFilter<>

Responses

204

The deleted email templates with the selected columns

DELETE/email_templates
curl -X DELETE "https://api.bookingmood.com/v1/email_templates" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update email templates

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this email template is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

attachmentsFilter<>

List of attachments to include in the email

bodyFilter<>

Body of the email

ftsFilter<>

Full text search index

include_booking_detailsFilter<>

Whether to include booking details in the email

include_booking_linkFilter<>

Whether to include a link to the booking status page in the email

include_ical_dataFilter<>

Whether to include an iCal attachment in the email

include_product_imageFilter<>

Whether to include a product image in the email

momentFilter<>

Moment at which the email should be sent. Formatted as { type: "check-in" | "checkout" | "confirmation" | "on-site" | "request", offset: integer }

past_schedule_behaviorFilter<>
statusFilter<>
subjectFilter<>

Subject of the email

timeFilter<>
triggerFilter<>

Trigger of the email template

typeFilter<>

Body

Partial<EmailTemplate>

Responses

204

The updated email templates with the selected columns

PATCH/email_templates
curl -X PATCH "https://api.bookingmood.com/v1/email_templates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'