Core resources
Administration
Booking flow
Events as visible on your timeline. Can be bookings, blocked periods or notes.
id
uuid
Unique identifier
calendar_id
uuid | null
Identifier of the external calendar this event is related to
created_at
timestamp with time zone
Creation timestamp
updated_at
timestamp with time zone
Last modification timestamp
end_date
date
Event end date
fts
tsvector
Full text search index
generated_title
text
Title of the event generated from the product name and the customer name
notes
text
Private notes about the event
origin
text | null
Origin of the event
padding
smallint
Padding of the event due to cooldown time
start_date
date
Event start date
status
"CANCELLED" | "TENTATIVE" | "CONFIRMED"
Status of the event
title
text
Title of the event
type
"booking" | "blocked period" | "note"
Type of the event
uid
text | null
Identifier of the event in the original calendar
{"id": "00000000-0000-0000-0000-000000000000","booking_id": "00000000-0000-0000-0000-000000000000","calendar_id": "00000000-0000-0000-0000-000000000000","creator_id": "00000000-0000-0000-0000-000000000000","product_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-09-08T01:16:50.050Z","updated_at": "2024-09-08T01:16:50.050Z","end_date": null,"generated_title": "","notes": "","origin": "","padding": 0,"start_date": null,"status": "CONFIRMED","title": "","type": "booking","uid": ""}
id
Filter<uuid>
Unique identifier
booking_id
Filter<uuid>
Identifier of the related booking
calendar_id
Filter<uuid>
Identifier of the external calendar this event is related to
creator_id
Filter<uuid>
Identifier of the user that created the event
product_id
Filter<uuid>
Identifier of the unit this event is related to
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
end_date
Filter<date>
Event end date
fts
Filter<tsvector>
Full text search index
generated_title
Filter<text>
Title of the event generated from the product name and the customer name
notes
Filter<text>
Private notes about the event
origin
Filter<text>
Origin of the event
padding
Filter<smallint>
Padding of the event due to cooldown time
start_date
Filter<date>
Event start date
status
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
Status of the event
title
Filter<text>
Title of the event
type
Filter<"booking" | "blocked period" | "note">
Type of the event
uid
Filter<text>
Identifier of the event in the original calendar
200
A list of calendar events with the selected columns
206
Partial Content
GET
/calendar_events
curl -X GET "https://api.bookingmood.com/v1/calendar_events?select=*" \ -H "Authorization: Bearer YOUR_API_KEY"
Partial<CalendarEvent>
| Array<Partial<CalendarEvent>>
201
The newly created calendar events with the selected columns
POST
/calendar_events
curl -X POST "https://api.bookingmood.com/v1/calendar_events" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '[]'
id
Filter<uuid>
Unique identifier
booking_id
Filter<uuid>
Identifier of the related booking
calendar_id
Filter<uuid>
Identifier of the external calendar this event is related to
creator_id
Filter<uuid>
Identifier of the user that created the event
product_id
Filter<uuid>
Identifier of the unit this event is related to
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
end_date
Filter<date>
Event end date
fts
Filter<tsvector>
Full text search index
generated_title
Filter<text>
Title of the event generated from the product name and the customer name
notes
Filter<text>
Private notes about the event
origin
Filter<text>
Origin of the event
padding
Filter<smallint>
Padding of the event due to cooldown time
start_date
Filter<date>
Event start date
status
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
Status of the event
title
Filter<text>
Title of the event
type
Filter<"booking" | "blocked period" | "note">
Type of the event
uid
Filter<text>
Identifier of the event in the original calendar
204
The deleted calendar events with the selected columns
DELETE
/calendar_events
curl -X DELETE "https://api.bookingmood.com/v1/calendar_events" \ -H "Authorization: Bearer YOUR_API_KEY"
id
Filter<uuid>
Unique identifier
booking_id
Filter<uuid>
Identifier of the related booking
calendar_id
Filter<uuid>
Identifier of the external calendar this event is related to
creator_id
Filter<uuid>
Identifier of the user that created the event
product_id
Filter<uuid>
Identifier of the unit this event is related to
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
end_date
Filter<date>
Event end date
fts
Filter<tsvector>
Full text search index
generated_title
Filter<text>
Title of the event generated from the product name and the customer name
notes
Filter<text>
Private notes about the event
origin
Filter<text>
Origin of the event
padding
Filter<smallint>
Padding of the event due to cooldown time
start_date
Filter<date>
Event start date
status
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
Status of the event
title
Filter<text>
Title of the event
type
Filter<"booking" | "blocked period" | "note">
Type of the event
uid
Filter<text>
Identifier of the event in the original calendar
Partial<CalendarEvent>
204
The updated calendar events with the selected columns
PATCH
/calendar_events
curl -X PATCH "https://api.bookingmood.com/v1/calendar_events" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '{}'