Skip to main content

FluentBooking

Provider id: fluent-booking ยท 21 tool(s).

fbook_create_bookingโ€‹

Book an appointment on a host's behalf. Emails attendees after creation. event_time is interpreted in the supplied timezone. The event must be published/active regardless of ignore_availability โ€” ignore_availability only bypasses the slot-availability check, not the event-active check. Use extra to pass additional fields not listed in the schema.

๐Ÿ”ด Destructive โ€” supports a dry_run preview flag.
Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
event_idintegeryesEvent (meeting type) ID.
namestringyesAttendee full name.
emailstringyesAttendee email.
timezonestringyesAttendee timezone (e.g. America/Chicago).
event_timestringyesSlot start time in the attendee's timezone (Y-m-d H:i:s).
location_typestringnoLocation type override.
location_descriptionstringnoLocation description.
guestsarraynoAdditional guest emails (strings) or {name,email} objects for multi-guest events.
messagestringnoAttendee message.
phone_numberstringnoAttendee phone number.
statusstringnoInitial booking status (defaults to plugin default).
sourcestringnoBooking source (default: admin).
host_user_idintegernoHost WordPress user ID to override the event's default host.
ignore_availabilitybooleannoIf true, bypass availability checks.
custom_fieldsobjectnoCustom field values keyed by field name.
extraobjectnoAdditional body fields merged in before all named params.

fbook_create_calendarโ€‹

Create a FluentBooking calendar (host). Body is wrapped under a top-level "calendar" key. Required slot keys: duration (โ‰ฅ5), event_type, availability_type, schedule_type, title (plus weekly_schedules/location_settings as needed). Use the "calendar" escape object to merge additional fields last.

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
author_timezonestringnoIANA timezone for the calendar host (e.g. America/New_York).
typestringnoCalendar type (e.g. simple = default host calendar, one per user; or team).
titlestringnoCalendar title.
slugstringnoURL slug; auto-generated if omitted.
slotobjectnoMeeting-type config. Required keys: duration (int, โ‰ฅ5 min), event_type (string), availability_type (string), schedule_type (string), title (string). Include weekly_schedules and location_settings as needed.
calendarobjectnoEscape hatch: additional fields merged into the calendar object last, overriding named params.

fbook_create_eventโ€‹

Create a FluentBooking event type (meeting type) on a calendar. Body is FLAT (not wrapped). Required settings keys: schedule_type and weekly_schedules. Use "extra" to merge additional fields first.

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
calendar_idintegeryesCalendar ID to add the event to.
titlestringyesEvent type title.
durationintegeryesMeeting duration in minutes (โ‰ฅ5).
event_typestringyesEvent type (e.g. one_to_one, group).
statusstringnoactive (default) or draft.
descriptionstringnoEvent description.
location_settingsarraynoLocation config items (each an object with type, etc.).
settingsobjectnoAvailability settings. Must include schedule_type and weekly_schedules.
extraobjectnoAdditional fields merged into the request body first.

fbook_delete_bookingโ€‹

Permanently delete a FluentBooking appointment (schedule) by ID.

๐Ÿ”ด Destructive โ€” supports a dry_run preview flag.
Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
booking_idintegeryesBooking (schedule) ID.

fbook_delete_calendarโ€‹

Permanently delete a FluentBooking calendar and all its event types.

๐Ÿ”ด Destructive โ€” supports a dry_run preview flag.
Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
calendar_idintegeryesCalendar ID to delete.

fbook_delete_eventโ€‹

Permanently delete a FluentBooking event type from a calendar.

๐Ÿ”ด Destructive โ€” supports a dry_run preview flag.
Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
calendar_idintegeryesCalendar ID.
event_idintegeryesEvent type ID to delete.

fbook_duplicate_eventโ€‹

Duplicate a FluentBooking event type (creates a "(clone)" draft). Optionally clone into a different calendar via new_calendar_id; defaults to the source calendar.

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
calendar_idintegeryesSource calendar ID.
event_idintegeryesSource event type ID.
new_calendar_idintegernoTarget calendar ID; defaults to source calendar if omitted.

fbook_get_available_slotsโ€‹

Get available booking time slots for an event type, optionally from a start date and in a timezone.

Profiles: full, lean, booking

Parameters

ParameterTypeRequiredDescription
event_idintegeryesEvent (meeting type) ID.
start_datestringnoStart date (Y-m-d); defaults to now.
timezonestringnoTimezone (e.g. America/Chicago); defaults to UTC.

fbook_get_bookingโ€‹

Get a FluentBooking appointment (schedule) by ID.

Profiles: full, lean, booking

Parameters

ParameterTypeRequiredDescription
idintegeryesSchedule (booking) ID.
with_all_databooleannoInclude extended meta/info.

fbook_get_booking_activitiesโ€‹

Get the activity log for a FluentBooking appointment (schedule).

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
booking_idintegeryesBooking (schedule) ID.

fbook_get_calendarโ€‹

Get a FluentBooking calendar by ID, including its event types ("slots").

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
calendar_idintegeryesCalendar ID.

fbook_get_eventโ€‹

Get a FluentBooking event type (meeting type) by calendar ID and event ID, with full settings.

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
calendar_idintegeryesCalendar ID.
event_idintegeryesEvent (meeting type) ID.

fbook_get_reportsโ€‹

Get FluentBooking booking report summary. Defaults to the last 30 days when start_time/end_time are omitted.

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
start_timestringnoReport start time (Y-m-d or datetime string). Defaults to 30 days ago.
end_timestringnoReport end time (Y-m-d or datetime string). Defaults to now.

fbook_list_bookingsโ€‹

List FluentBooking appointments (schedules). Defaults to upcoming; pass period="all" for everything. Filter by host/calendar, event, and date range.

Profiles: full, lean, booking

Parameters

ParameterTypeRequiredDescription
periodstringnoupcoming, completed, cancelled, pending, no_show, latest_bookings, or all.
authorstringnoHost/calendar filter: a user ID, calendar ID, "me", or "all".
eventintegernoLimit to a specific event (meeting type) ID.
emailstringnoFilter by attendee email.
date_fromstringnoRange start (Y-m-d). Requires date_to.
date_tostringnoRange end (Y-m-d). Requires date_from.
searchstringnoSearch term.
per_pageintegernoItems per page (default 15).
pageintegernoPage number.

fbook_list_calendarsโ€‹

List FluentBooking calendars (hosts). Each calendar embeds its event types ("slots").

Profiles: full, lean, booking

Parameters

ParameterTypeRequiredDescription
searchstringnoSearch term.
calendar_typestringnoFilter by calendar type (e.g. simple) or "all".
per_pageintegernoItems per page (default 15).
pageintegernoPage number.

fbook_list_routesโ€‹

List the FluentBooking REST routes registered under /fluent-booking/v2 and their HTTP methods. Optional "search" substring filter and "limit" (1-500, default 200). Use this to find a path for fbook_request.

Passthrough router โ€” available in every toolset profile.
Profiles: all profiles

Parameters

ParameterTypeRequiredDescription
searchstringnoOnly return routes whose path contains this substring.
limitintegernoMax routes to return (1-500, default 200).

fbook_requestโ€‹

Call any FluentBooking REST route (scoped to /fluent-booking/v2). GET runs immediately; POST/PUT/PATCH/DELETE require "confirm": true, or pass "dry_run": true to preview the request. Use fbook_list_routes to discover available paths.

Passthrough router โ€” available in every toolset profile.
Profiles: all profiles

Parameters

ParameterTypeRequiredDescription
methodstringyesHTTP method: GET, POST, PUT, PATCH, or DELETE.
pathstringyesRoute path within /fluent-booking/v2, e.g. /fluent-booking/v2/contacts or /fluent-booking/v2/contacts/42.
bodyobjectnoRequest body for writes (JSON object).
queryobjectnoQuery-string arguments (JSON object).
confirmbooleannoRequired to execute a write (POST/PUT/PATCH/DELETE).

fbook_send_confirmation_emailโ€‹

Send (or resend) the confirmation email for a booking. Triggers real email delivery.

๐Ÿ”ด Destructive โ€” supports a dry_run preview flag.
Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
booking_idintegeryesBooking (schedule) ID.
email_tostringnoRecipient: guest (default) or host.

fbook_set_booking_statusโ€‹

Update a booking's status via a single-field status update (PUT /schedules/{id}). Accepted statuses: scheduled, completed, cancelled, rejected, no_show. Pass reason (sent as cancel_reason or reject_reason) for cancelled/rejected โ€” the API reads it raw so an empty string is sent when omitted. Pass refund_payment=true to trigger a refund for cancelled/rejected bookings. Pass update_all=true to bulk-update a multi-guest group for no_show/completed. Note: the API rejects setting a value equal to the current one ("No changes found").

๐Ÿ”ด Destructive โ€” supports a dry_run preview flag.
Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
booking_idintegeryesBooking (schedule) ID.
statusstringyesNew status.
reasonstringnoReason used as cancel_reason (cancelled) or reject_reason (rejected).
refund_paymentbooleannoTrigger a payment refund; only honoured for cancelled/rejected.
update_allbooleannoBulk-update all guests in a multi-guest group; only honoured for no_show/completed.

fbook_update_booking_fieldโ€‹

Edit one attendee or booking field via a single-field update (PUT /schedules/{id}); edits one stored booking field per call. Note: the API rejects setting a value equal to the current one ("No changes found").

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
booking_idintegeryesBooking (schedule) ID.
fieldstringyesField to update.
valuestringyesNew value for the field.

fbook_update_event_detailsโ€‹

Update a FluentBooking event type's details (POST to /details endpoint). Body is FLAT. title and duration are always required by the API (it is a full-details save, not a partial patch). For group events, max_book_per_slot and is_display_spots are also required. Use "extra" to merge additional fields first.

Profiles: full, booking

Parameters

ParameterTypeRequiredDescription
calendar_idintegeryesCalendar ID.
event_idintegeryesEvent type ID.
titlestringyesNew title.
durationintegeryesNew duration in minutes.
statusstringnoactive or draft.
descriptionstringnoEvent description.
color_schemastringnoHex color string (e.g. #ff0000).
max_book_per_slotintegernoMax bookings per slot (required for group events).
is_display_spotsintegerno0 or 1 โ€” whether to show remaining spots (required for group events).
location_settingsarraynoLocation config items.
settingsobjectnoEvent settings object (e.g. multi_duration). Does NOT update availability schedules or booking limits โ€” those are separate endpoints (use fbook_request).
extraobjectnoAdditional fields merged into the request body first.