Core resources
Administration
Booking flow
Re-usable email templates
id
uuid
Unique identifier
organization_id
uuid
Identifier of the organization this email template is defined in
created_at
timestamp with time zone
Creation timestamp
updated_at
timestamp with time zone
Last modification timestamp
attachments
jsonb
List of attachments to include in the email
body
jsonb
Body of the email
fts
tsvector
Full text search index
include_booking_details
boolean
Whether to include booking details in the email
include_booking_link
boolean
Whether to include a link to the booking status page in the email
include_ical_data
boolean
Whether to include an iCal attachment in the email
include_product_image
boolean
Whether to include a product image in the email
moment
jsonb | null
Moment at which the email should be sent. Formatted as { type: "check-in" | "checkout" | "confirmation" | "on-site" | "request", offset: integer }
past_schedule_behavior
text
status
"CANCELLED" | "TENTATIVE" | "CONFIRMED"
subject
jsonb
Subject of the email
time
time without time zone | null
trigger
text | null
Trigger of the email template
type
text
{"id": "00000000-0000-0000-0000-000000000000","organization_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-09-08T01:10:39.313Z","updated_at": "2024-09-08T01:10:39.313Z","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"}
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this email template is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
attachments
Filter<jsonb>
List of attachments to include in the email
body
Filter<jsonb>
Body of the email
fts
Filter<tsvector>
Full text search index
include_booking_details
Filter<boolean>
Whether to include booking details in the email
include_booking_link
Filter<boolean>
Whether to include a link to the booking status page in the email
include_ical_data
Filter<boolean>
Whether to include an iCal attachment in the email
include_product_image
Filter<boolean>
Whether to include a product image in the email
moment
Filter<jsonb>
Moment at which the email should be sent. Formatted as { type: "check-in" | "checkout" | "confirmation" | "on-site" | "request", offset: integer }
past_schedule_behavior
Filter<text>
status
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
subject
Filter<jsonb>
Subject of the email
time
Filter<time without time zone>
trigger
Filter<text>
Trigger of the email template
type
Filter<text>
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"
Partial<EmailTemplate>
| Array<Partial<EmailTemplate>>
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 '[]'
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this email template is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
attachments
Filter<jsonb>
List of attachments to include in the email
body
Filter<jsonb>
Body of the email
fts
Filter<tsvector>
Full text search index
include_booking_details
Filter<boolean>
Whether to include booking details in the email
include_booking_link
Filter<boolean>
Whether to include a link to the booking status page in the email
include_ical_data
Filter<boolean>
Whether to include an iCal attachment in the email
include_product_image
Filter<boolean>
Whether to include a product image in the email
moment
Filter<jsonb>
Moment at which the email should be sent. Formatted as { type: "check-in" | "checkout" | "confirmation" | "on-site" | "request", offset: integer }
past_schedule_behavior
Filter<text>
status
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
subject
Filter<jsonb>
Subject of the email
time
Filter<time without time zone>
trigger
Filter<text>
Trigger of the email template
type
Filter<text>
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"
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this email template is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
attachments
Filter<jsonb>
List of attachments to include in the email
body
Filter<jsonb>
Body of the email
fts
Filter<tsvector>
Full text search index
include_booking_details
Filter<boolean>
Whether to include booking details in the email
include_booking_link
Filter<boolean>
Whether to include a link to the booking status page in the email
include_ical_data
Filter<boolean>
Whether to include an iCal attachment in the email
include_product_image
Filter<boolean>
Whether to include a product image in the email
moment
Filter<jsonb>
Moment at which the email should be sent. Formatted as { type: "check-in" | "checkout" | "confirmation" | "on-site" | "request", offset: integer }
past_schedule_behavior
Filter<text>
status
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
subject
Filter<jsonb>
Subject of the email
time
Filter<time without time zone>
trigger
Filter<text>
Trigger of the email template
type
Filter<text>
Partial<EmailTemplate>
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 '{}'