Core resources


Administration


Booking flow

Calendar events

Events as visible on your timeline. Can be bookings, blocked periods or notes.

The calendar event object

Attributes

iduuid

Unique identifier

booking_iduuid | null
bookings.id

Identifier of the related booking

calendar_iduuid | null
external_calendars.id

Identifier of the external calendar this event is related to

creator_iduuid | null
user_profiles.user_id

Identifier of the user that created the event

product_iduuid
products.id

Identifier of the unit this event is related to

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

end_datedate

Event end date

ftstsvector

Full text search index

generated_titletext

Title of the event generated from the product name and the customer name

notestext

Private notes about the event

origintext | null

Origin of the event

paddingsmallint

Padding of the event due to cooldown time

start_datedate

Event start date

status"CANCELLED" | "TENTATIVE" | "CONFIRMED"

Status of the event

titletext

Title of the event

type"booking" | "blocked period" | "note"

Type of the event

uidtext | null

Identifier of the event in the original calendar

The calendar event object
{
"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-04-20T03:16:52.540Z",
"updated_at": "2024-04-20T03:16:52.540Z",
"end_date": null,
"generated_title": "",
"notes": "",
"origin": "",
"padding": 0,
"start_date": null,
"status": "CONFIRMED",
"title": "",
"type": "booking",
"uid": ""
}

List calendar events

Filters

idFilter<uuid>

Unique identifier

booking_idFilter<uuid>

Identifier of the related booking

calendar_idFilter<uuid>

Identifier of the external calendar this event is related to

creator_idFilter<uuid>

Identifier of the user that created the event

product_idFilter<uuid>

Identifier of the unit this event is related to

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

end_dateFilter<date>

Event end date

ftsFilter<tsvector>

Full text search index

generated_titleFilter<text>

Title of the event generated from the product name and the customer name

notesFilter<text>

Private notes about the event

originFilter<text>

Origin of the event

paddingFilter<smallint>

Padding of the event due to cooldown time

start_dateFilter<date>

Event start date

statusFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">

Status of the event

titleFilter<text>

Title of the event

typeFilter<"booking" | "blocked period" | "note">

Type of the event

uidFilter<text>

Identifier of the event in the original calendar

Responses

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"

Create calendar events

Body

Partial<CalendarEvent>
| Array<Partial<CalendarEvent>>

Responses

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 '[]'

Delete calendar events

Filters

idFilter<uuid>

Unique identifier

booking_idFilter<uuid>

Identifier of the related booking

calendar_idFilter<uuid>

Identifier of the external calendar this event is related to

creator_idFilter<uuid>

Identifier of the user that created the event

product_idFilter<uuid>

Identifier of the unit this event is related to

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

end_dateFilter<date>

Event end date

ftsFilter<tsvector>

Full text search index

generated_titleFilter<text>

Title of the event generated from the product name and the customer name

notesFilter<text>

Private notes about the event

originFilter<text>

Origin of the event

paddingFilter<smallint>

Padding of the event due to cooldown time

start_dateFilter<date>

Event start date

statusFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">

Status of the event

titleFilter<text>

Title of the event

typeFilter<"booking" | "blocked period" | "note">

Type of the event

uidFilter<text>

Identifier of the event in the original calendar

Responses

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"

Update calendar events

Filters

idFilter<uuid>

Unique identifier

booking_idFilter<uuid>

Identifier of the related booking

calendar_idFilter<uuid>

Identifier of the external calendar this event is related to

creator_idFilter<uuid>

Identifier of the user that created the event

product_idFilter<uuid>

Identifier of the unit this event is related to

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

end_dateFilter<date>

Event end date

ftsFilter<tsvector>

Full text search index

generated_titleFilter<text>

Title of the event generated from the product name and the customer name

notesFilter<text>

Private notes about the event

originFilter<text>

Origin of the event

paddingFilter<smallint>

Padding of the event due to cooldown time

start_dateFilter<date>

Event start date

statusFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">

Status of the event

titleFilter<text>

Title of the event

typeFilter<"booking" | "blocked period" | "note">

Type of the event

uidFilter<text>

Identifier of the event in the original calendar

Body

Partial<CalendarEvent>

Responses

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 '{}'