Skip to main content
Bookingmood logo
  • Category: scheduling & booking
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 142
  • Triggers: 0
  • Slug: BOOKINGMOOD
  • Version: 20261101_00

Tools

Slug: BOOKINGMOOD_CREATE_PRODUCTTool to create a new bookable product in the organization. Use this when you need to register a new rental property, accommodation, or bookable item in the system. This action will automatically update your subscription based on the product count.

Input Parameters

object
required
Product name as a localized object with language keys. Must include at least ‘default’ key for the default language.
string
required
Timezone for the product’s availability and bookings. Use IANA timezone format (e.g., ‘UTC’, ‘America/New_York’, ‘Europe/Amsterdam’).
object
Product description as a localized object with language keys. Can include multiple translations.
string ("nightly" | "daily")
required
Rental period type: ‘nightly’ for overnight stays or ‘daily’ for day rentals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_CREATE_SITE_PAGESTool to create new site pages. Use when you need to add pages to a site in the organization.

Input Parameters

array
List of site pages to create. Can be an empty array.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_CREATE_WIDGETTool to create a new booking widget. Use after preparing widget parameters.

Input Parameters

string
required
Title of the widget
string ("calendar" | "timeline" | "inventory" | "search")
required
Type of the widget
string
Language tag for widget locale
string
Currency code for widget pricing
object
JSON settings object for widget customization
boolean
Whether to show past dates
string ("book" | "forward")
Interaction type: book or forward
string ("today" | "next-open" | "next-available")
Initial date shown in the calendar
string
URL to redirect after booking submission
boolean
Whether to show reviews
boolean
Whether date-selection stays expanded after pick
string
How to display booked dates
string
How to display closed dates
array
Deprecated: list of visible months in calendar
string ("all" | "hide-unavailable" | "hide-closed" | "custom")
Visible dates in the calendar
string
required
UUID of the organization this widget belongs to
string ("CANCELLED" | "TENTATIVE" | "CONFIRMED")
How to display pending dates
boolean
Whether to show Bookingmood branding

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_ATTRIBUTESTool to delete attributes matching given filters. Use after confirming which attribute records to remove.

Input Parameters

string
Unique identifier of the attribute to delete (UUID format).
object
Filter by localized name as JSON object (MultiLanguageString), e.g., {‘en’: ‘Color’}.
string
Filter by attribute type. Use ‘single-select’ or ‘multi-select’.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators, e.g., ‘gte.2025-01-01T00:00:00Z’.
string
Filter by organization ID (UUID format, references organizations.id).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_BOOKING_DETAILSTool to delete booking details matching given filters. Use after confirming which booking detail records to remove.

Input Parameters

string
Unique identifier of the booking detail to delete.
object
Localized name of the form field as JSON object, e.g., {‘en’: ‘Name’}.
string
Value filled in by the customer.
string
Identifier of the selected option.
string
Identifier of the related booking.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators, e.g., ‘gte.2025-01-01T00:00:00Z’.
string
Identifier of the related service.
string
Filter by last modification timestamp (ISO 8601). Supports PostgREST operators, e.g., ‘lte.2025-01-02T00:00:00Z’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_BOOKINGSTool to delete bookings matching given filters. Use when you need to remove bookings from the system. At least one filter parameter is required to prevent accidental deletion of all bookings.

Input Parameters

string
Filter by unique identifier of the booking. Use ‘eq.<uuid>’ format for exact match or provide UUID directly.
string
Filter by site identifier. Use to delete all bookings for a specific site.
string
Filter by widget identifier. Use to delete all bookings created through a specific widget.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators, e.g., ‘gte.2025-01-01T00:00:00Z’ for bookings created on or after date.
string
Filter by update timestamp (ISO 8601). Supports PostgREST operators, e.g., ‘lte.2025-12-31T23:59:59Z’ for bookings updated before date.
string
Filter by confirmation timestamp (ISO 8601). Supports PostgREST operators to filter confirmed or unconfirmed bookings.
string
Filter by organization identifier. Use to delete all bookings for a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_CALENDAR_EVENT_NOTESTool to delete calendar event notes matching given filters. Use after confirming which notes to remove. At least one filter parameter is required to prevent accidental bulk deletion.

Input Parameters

string
Filter by calendar event note ID. Supports PostgREST operators, e.g., ‘eq.00000000-0000-0000-0000-000000000000’.
string
Filter by note text content. Supports PostgREST operators like ‘like.meeting’ or ‘ilike.MEETING’.
string
Filter by author (user) ID. Supports PostgREST operators.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators, e.g., ‘gte.2025-01-01T00:00:00Z’.
string
Filter by last modification timestamp (ISO 8601). Supports PostgREST operators, e.g., ‘lte.2025-12-31T23:59:59Z’.
string
Filter by associated calendar event ID. Supports PostgREST operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_CALENDAR_EVENTSTool to delete calendar events matching given filters. Use after confirming which calendar event records to remove.

Input Parameters

string
Filter by calendar event ID using PostgREST operators (e.g., eq.<uuid>).
string
Filter by event type using PostgREST operators (e.g., eq.booking).
string
Filter by event status using PostgREST operators (e.g., eq.CONFIRMED).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_CALENDAR_EVENT_TASKSTool to delete calendar event tasks matching given filters. Use after confirming which calendar event task records to remove.

Input Parameters

string
Filter by calendar event task ID using PostgREST operators (e.g., id=eq.00000000-0000-0000-0000-000000000000).
string
Filter by product task ID using PostgREST operators (e.g., product_task_id=eq.22222222-3333-4444-5555-666666666666).
string
Filter by calendar event ID using PostgREST operators (e.g., calendar_event_id=eq.11111111-2222-3333-4444-555555555555).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_CAPACITIESTool to delete capacities matching given filters. Use when you need to remove capacity records from the system.

Input Parameters

string
Filter by unique identifier. Use ‘eq.’ prefix for exact match (e.g., ‘eq.00000000-0000-0000-0000-000000000001’).
string
Filter by maximum occupancy value. Supports PostgREST operators like ‘eq.’, ‘gte.’, ‘lte.’.
string
Filter by minimum occupancy value. Supports PostgREST operators like ‘eq.’, ‘gte.’, ‘lte.’.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators like ‘gte.’, ‘lte.’.
string
Filter by related product identifier. Supports PostgREST operators like ‘eq.’, ‘in.’.
string
Filter by last modification timestamp (ISO 8601). Supports PostgREST operators like ‘gte.’, ‘lte.’.
string
Filter by related capacity group identifier. Supports PostgREST operators like ‘eq.’, ‘in.’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_CAPACITY_GROUP_DEPSTool to delete capacity group dependencies matching given filters. Use after confirming which dependency records to remove.

Input Parameters

string
Filter by unique identifier of the capacity group dependency.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators, e.g., ‘gte.2025-01-01T00:00:00Z’.
string
Filter by identifier of the accumulated capacity group.
string
Filter by identifier of the accumulating capacity group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_CAPACITY_GROUPSTool to delete capacity groups matching given filters. Use after confirming which capacity group records to remove.

Input Parameters

string
Filter by capacity group UUID.
string
Filter by localized name. Supports PostgREST operators, e.g., ‘eq.GroupName’ or ‘ilike.search’.
string ("manual" | "sum")
Enum for capacity group type.
integer
Filter by display order.
string
Filter by organization identifier.
boolean
Filter by explicit input requirement flag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_CONTACT_BOOKINGSTool to delete contact bookings matching given filters. Use after confirming which contact booking records to remove.

Input Parameters

string
Unique identifier of the contact booking to delete. Use PostgREST syntax, e.g., ‘eq.00000000-0000-0000-0000-000000000000’.
string
Specify which columns to return in the response (PostgREST select syntax).
string
Filter by booking ID (reference to bookings.id). Use PostgREST syntax, e.g., ‘eq.11111111-2222-3333-4444-555555555555’.
string
Filter by contact ID (reference to contacts.id). Use PostgREST syntax, e.g., ‘eq.22222222-3333-4444-5555-666666666666’.
string
Filter by creation timestamp. Supports PostgREST operators, e.g., ‘gt.2024-01-01T00:00:00Z’ for records created after a date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_CONTACTSTool to delete customer contacts from the system. Use after confirming which contacts to remove. Supports filter patterns like email=like.%test.com to delete test contacts.

Input Parameters

string
Filter contacts by ID using PostgREST operators like ‘eq’, etc. Note: ‘in’ operator may not be supported for this field.
string
Filter contacts by email using PostgREST operators like ‘like’, ‘eq’, ‘ilike’, etc. Example: ‘like.%test.com’ to delete all test contacts with emails ending in test.com.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_COUPON_PRODUCTSTool to delete coupon product links matching given filters. Use when you need to remove associations between coupons and products. At least one filter parameter is required.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by coupon ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all product links for a specific coupon.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all coupon links for a specific product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_COUPONSTool to delete coupons matching given filters. Use after confirming which coupons to remove. Supports PostgREST-style filtering on all fields.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000000’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by coupon code using PostgREST operators. Examples: ‘eq.SUMMER2024’ (equals), ‘like.SALE’ (pattern match), ‘in.(CODE1,CODE2)’ (in list). Use this to delete specific coupons by their code.
string
Filter by coupon scope using PostgREST operators. Valid scopes: ‘global’, ‘product’, ‘service’, or ‘rent’. Examples: ‘eq.global’ (equals), ‘in.(product,service)’ (in list).
string
Filter by stackable flag using PostgREST operators. Examples: ‘eq.true’ (equals true), ‘eq.false’ (equals false). Use ‘is.true’ or ‘is.false’ for boolean filtering.
string
Filter by organization UUID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all coupons for a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_COUPON_SERVICESTool to delete coupon service links matching given filters. Use after confirming which coupon-service associations to remove. Supports PostgREST-style filtering on all fields.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000000’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Specify which columns to return from deleted records. Use ’*’ for all fields or comma-separated column names like ‘id,coupon_id,service_id’. If not specified, returns minimal information.
string
Filter by coupon ID (references coupons.id) using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all service links for a specific coupon.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by service ID (references services.id) using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all coupon links for a specific service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_COUPON_USESTool to delete coupon use records matching given filters. Use after confirming which coupon uses to remove. Supports PostgREST-style filtering on all fields.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000000’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by coupon ID (references coupons.id) using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all uses for a specific coupon.
string
Filter by booking ID (references bookings.id) using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all coupon uses for a specific booking.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_EMAIL_TEMPLATESTool to delete email templates matching given filters. Use after confirming which email template records to remove.

Input Parameters

string
Unique identifier of the email template to delete (UUID format). Uses PostgREST filter syntax: ?id=eq.{uuid}.
string
Filter by template title.
string
Filter by organization ID (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_EXTERNAL_CALENDARSTool to delete external calendars by ID. Use when you need to remove an external calendar integration from the system.

Input Parameters

string
required
Filter by external calendar ID using PostgREST operators (e.g., eq.<uuid>). This field is required as the API requires a WHERE clause for DELETE operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_INVOICESDelete invoices matching a required ID filter. Supports PostgREST operators, including filters that can match multiple invoices.

Input Parameters

string
required
Unique identifier of the invoice to delete (UUID format). DELETE operations require a WHERE clause - this parameter is mandatory and must be a valid UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_LINE_ITEMSDelete booking line items matching the supplied filters, such as a booking ID or line item ID. At least one filter is required. Deleted items are returned when available; an empty result does not necessarily mean no items were deleted.

Input Parameters

string
Filter by line item ID (UUID). Use eq. prefix for exact match.
string
Filter by amount (real number). Use operators like eq., gt., lt., gte., lte.
string
Filter by tax ID (UUID). Deletes all line items with the specified tax configuration.
string
Filter by quantity (integer). Use operators like eq., gt., lt., gte., lte.
string
Filter by booking ID (UUID). Deletes all line items for the specified booking.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators like gte., lte., gt., lt.
string
Filter by service ID (UUID). Deletes all line items for the specified service.
string
Filter by unit price (real number). Use operators like eq., gt., lt., gte., lte.
string
Filter by update timestamp (ISO 8601). Supports PostgREST operators like gte., lte., gt., lt.
string
Filter by description (MultiLanguageString). Use eq. prefix for exact match or like./ilike. for pattern matching.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_LINE_ITEM_TAXESTool to delete line item taxes matching given filters. Use when you need to remove line item tax records from the system.

Input Parameters

string
Filter by unique identifier (UUID format). Use PostgREST operators like ‘eq.’ for exact match. Example: ‘eq.00000000-0000-0000-0000-000000000000’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_PAYMENTSTool to delete payments matching given filters. Use when you need to remove payments from the system. At least one filter parameter is required to prevent accidental deletion of all payments. Supported filters: id, invoice_id, or booking_id (all in UUID format).

Input Parameters

string
Filter by payment ID (UUID format). Use ‘eq.<uuid>’ format for exact match or provide UUID directly. Example: ‘eq.00000000-0000-0000-0000-000000000000’
string
Filter by booking ID (UUID format). Use to delete all payments associated with a specific booking. Provide UUID directly or with ‘eq.’ prefix.
string
Filter by invoice ID (UUID format). Use to delete all payments associated with a specific invoice. Provide UUID directly or with ‘eq.’ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_PERMISSIONSDelete permissions matching the given filters; at least one filter is required. The returned deleted count is always zero and does not indicate how many permissions were removed.

Input Parameters

string
Filter by permission UUID. Use PostgREST operators like ‘eq’, ‘neq’, ‘in’. Example: ‘eq.00000000-0000-0000-0000-000000000001’ to delete a specific permission.
string
Filter by member UUID. Use PostgREST operators like ‘eq’, ‘neq’, ‘in’. Example: ‘eq.11111111-2222-3333-4444-555555555555’ to delete all permissions for a specific member.
string
Filter by product UUID. Use PostgREST operators like ‘eq’, ‘neq’, ‘in’. Example: ‘eq.66666666-7777-8888-9999-000000000000’ to delete all permissions for a specific product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_PRICING_WIDGETSTool to delete pricing widgets matching given filters. Use after confirming which pricing widgets to remove. Requires ID filter for safety.

Input Parameters

string
required
Filter by unique identifier using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000000’ (equals), ‘in.(uuid1,uuid2)’ (in list). DELETE requires a WHERE clause for safety.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_PRODUCT_ATTR_OPTIONSTool to delete product attribute options matching given filters. Use when you need to remove product attribute option records from the system. At least one filter parameter is required.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.123e4567-e89b-12d3-a456-426614174000’ (equals), ‘in.(uuid1,uuid2)’ (in list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_PRODUCT_CONFIGURATIONSTool to delete product configurations matching given filters. Use when you need to remove product configuration records from the system.

Input Parameters

string
Filter by unique identifier (UUID format). Supports PostgREST operators like ‘eq.’, ‘in.’.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators like ‘gte.’, ‘lte.’.
string
Filter by product identifier (UUID format). Supports PostgREST operators like ‘eq.’, ‘in.’.
string
Filter by last modification timestamp (ISO 8601). Supports PostgREST operators like ‘gte.’, ‘lte.’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_PRODUCT_REPLY_ADDRSTool to delete product reply-to addresses matching given filters. Use after confirming which reply-to address records to remove.

Input Parameters

string
Unique identifier of the product reply-to address to delete (UUID format). Supports PostgREST operators, e.g., ‘eq.00000000-0000-0000-0000-000000000000’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_PRODUCT_SERVICESDelete product service links using the supplied filters. A request containing only the select parameter has no deletion filter and can delete all accessible product service links.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000001’ (equals), ‘in.(uuid1,uuid2)’ (in list). Recommended to avoid deleting all records.
string
Specify which columns to return from deleted records. Use ’*’ for all fields or comma-separated column names like ‘id,product_id,service_id’. If not specified, returns minimal information.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all service links for a specific product.
string
Filter by service ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all product links for a specific service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_REPLY_TO_ADDRESSESTool to delete reply-to addresses matching given filters. Use after confirming which reply-to addresses to remove. Supports PostgREST-style filtering.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000000’ (equals), ‘in.(uuid1,uuid2)’ (in list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_REVIEW_PRODUCTSTool to delete review products matching given filters. Use when you need to remove review product records from the system. At least one filter parameter is required.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_REVIEWSTool to delete reviews matching given filters. Use when you need to remove review records from the system. At least one filter parameter is required.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2025-01-01T00:00:00Z’ (greater than or equal), ‘lte.2025-12-31T23:59:59Z’ (less than or equal).
string
Filter by organization UUID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_REVIEW_WIDGET_LISTINGSTool to delete review widget listings matching given filters. Use after confirming which review widget listings to remove. Supports PostgREST-style filtering.

Input Parameters

string
Filter by review widget listing ID using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000000’ (equals), ‘in.(uuid1,uuid2)’ (in list). This parameter accepts UUID format and uses PostgREST filter syntax.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_SERVICESTool to delete services matching given filters. Use after confirming which services to remove. Supports PostgREST-style filtering with operators like eq, in, etc.

Input Parameters

string
Filter by service ID using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000000’ (equals specific UUID), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to delete all services for a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_SITE_NAV_ITEMSTool to delete site navigation items matching given filters. Use after confirming which navigation items to remove. DELETE operation requires a WHERE clause (at least one filter parameter).

Input Parameters

string
Filter by unique identifier using PostgREST operators. Use ‘eq’ for exact match (e.g., ‘eq.00000000-0000-0000-0000-000000000000’). The ‘neq’ operator is also supported.
string
Filter by navigation item label using PostgREST operators. Use ‘eq’ for exact match (e.g., ‘eq.Home’).
integer
Limit number of site navigation items to delete. Must be used with ‘order’ parameter for deterministic results.
string
Sort results by field name before deletion. Required when using limit. Format: ‘field’ or ‘field.desc’ for descending order.
integer
Offset for pagination when deleting items. Should be used with ‘order’ and ‘limit’ parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_SITE_PAGESTool to delete site pages matching given filters. Use after confirming which site pages to remove. DELETE endpoint requires a WHERE clause via filter parameters.

Input Parameters

string
required
Filter by unique identifier (UUID format) using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000001’ (equals), ‘in.(uuid1,uuid2)’ (in list). DELETE requires a WHERE clause - at least this filter parameter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_TAXESTool to delete taxes matching given filters. Use after confirming which tax records to remove.

Input Parameters

string
Filter by unique identifier using PostgREST operators. Examples: ‘eq.00000000-0000-0000-0000-000000000000’ (equals), ‘in.(uuid1,uuid2)’ (in list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_WEBHOOKSTool to delete webhooks matching given filters. Use after confirming which webhooks to remove. Supports PostgREST-style filtering.

Input Parameters

string
Filter webhooks by UUID using PostgREST operators like ‘eq’, ‘in’, etc. Example: ‘eq.00000000-0000-0000-0000-000000000000’ (equals), ‘in.(uuid1,uuid2)’ (in list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_WIDGET_LISTINGSTool to delete widget listings matching given filters. Use after confirming which widget listings to remove. Supports PostgREST-style filtering.

Input Parameters

string
Filter by widget listing ID using PostgREST operators. Examples: ‘eq.550e8400-e29b-41d4-a716-446655440000’ (equals), ‘in.(uuid1,uuid2)’ (in list). This parameter accepts UUID format and uses PostgREST filter syntax.
integer
Limit number of widget listings to delete (max 1000).
string
Sort results by field name before deletion.
integer
Offset for pagination when deleting widget listings.
string
Filter by widget ID using PostgREST operators. Use ‘eq.’ prefix for exact match.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators like ‘gte.’, ‘lte.’.
string
Filter by listing ID using PostgREST operators. Use ‘eq.’ prefix for exact match.
string
Filter by last modification timestamp (ISO 8601). Supports PostgREST operators like ‘gte.’, ‘lte.’.
string
Filter by organization ID using PostgREST operators. Use ‘eq.’ prefix for exact match.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_DELETE_WIDGETSTool to delete widgets from the system. Use when you need to remove widget configurations. Supports PostgREST filtering with operators like id=eq.uuid.

Input Parameters

string
Filter widgets by ID using PostgREST operators like ‘eq’, ‘in’, ‘gt’, ‘lt’, ‘neq’, ‘is’, etc. Example: ‘eq.00000000-0000-0000-0000-000000000000’ to delete a specific widget.
string
Filter widgets by type using PostgREST operators like ‘eq’, ‘in’, etc. Common types: calendar, timeline, inventory, search.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_INVITE_MEMBERTool to invite a member to your organization. The member will receive an email with a link to accept the invitation. Use this when you need to add new team members or grant access to your BookingMood organization.

Input Parameters

string
required
Email address of the member to invite. The member will receive an email with a link to accept the invitation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_ATTRIBUTE_OPTIONSList attribute options with filtering and pagination. Filter by attribute ID, name, or creation date, and sort results; the limit parameter accepts up to 1000.

Input Parameters

string
Filter by unique identifier (UUID format).
string
Filter by localized option name.
integer
Maximum number of results per request (default: 1000, max: 1000).
integer
Number of results to skip for pagination.
string
Specify which columns to retrieve (e.g., ‘select=*’ for all columns).
string
Filter by creation timestamp (ISO 8601 format with timezone).
string
Sort results by column with direction (e.g., ‘created_at.desc’ for descending, ‘name.asc’ for ascending). This maps to the ‘order’ query parameter in the API.
string
Filter by related attribute identifier (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_ATTRIBUTESTool to retrieve custom attributes defined for products. Use when you need to list all available attributes with optional field filtering via the select parameter. Attributes are custom fields that can be associated with products in the Bookingmood system.

Input Parameters

integer
Maximum number of attributes to return (max: 1000).
string
Sort results by field. Use PostgREST syntax like ‘created_at.desc’ or ‘id.asc’. Can sort by any field.
integer
Number of attributes to skip before starting to return results (for pagination).
string
Query parameter to filter which fields to return (e.g., ‘select=*’ to return all fields, or ‘select=id,name’ for specific fields).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_BOOKING_DETAILSList booking details with filtering and pagination. Booking details contain guest-filled form field data such as names, contact info, and custom field values. Use this to retrieve booking detail records, optionally filtered by booking ID, service ID, timestamps, or customer values. Supports PostgREST query operators for flexible filtering.

Input Parameters

string
Filter by booking detail ID. Supports PostgREST operators (e.g., ‘eq.uuid’, ‘in.(uuid1,uuid2)’).
integer
Maximum number of booking details to return (max: 1000).
string
Sort results by field. Use field.asc or field.desc (e.g., ‘created_at.desc’, ‘value.asc’).
string
Filter by customer-provided value. Supports PostgREST operators (e.g., ‘eq.text’, ‘like.pattern’).
integer
Number of booking details to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all columns or comma-separated list (e.g., ‘id,booking_id,value’).
string
Filter by selected option ID. Supports PostgREST operators.
string
Filter by related booking ID. Supports PostgREST operators.
string
Filter by creation timestamp (ISO 8601). Supports PostgREST operators (e.g., ‘gte.2025-01-01T00:00:00Z’, ‘lte.2025-12-31T23:59:59Z’).
string
Filter by related service ID. Supports PostgREST operators.
string
Filter by last modification timestamp (ISO 8601). Supports PostgREST operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_BOOKINGSRetrieve bookings with optional filtering and pagination. Returns booking records with reference codes, organization IDs, timestamps, and currency information; search by reference or organization or paginate through results.

Input Parameters

string
Filter bookings by exact ID match.
integer
Maximum number of bookings to return per request. Default and maximum is 1000.
string
Sort order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘reference.asc’).
string
Filter bookings by booking method. Valid values are ‘request’ (booking request) or ‘book’ (direct booking).
integer
Number of bookings to skip before returning results. Used for pagination.
string
Columns to retrieve from bookings table. Use ’*’ for all columns, or specify comma-separated field names (e.g., ‘id,reference,created_at’). Can include related resource columns.
string
Filter bookings by the site where the booking was made.
string
Filter bookings by the public-facing booking reference code.
string
Filter bookings by the widget where the booking occurred.
string
Filter bookings by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_BOOKING_UPDATESTool to list booking updates with filtering and pagination. Use when you need to retrieve booking update history, track changes to bookings, or audit booking modifications. Supports PostgREST query parameters for flexible filtering by ID, booking ID, user ID, and creation timestamp.

Input Parameters

string
Filter by booking update ID using PostgREST operators. Example: ‘eq.uuid-value’ for exact match, ‘in.(uuid1,uuid2)’ for multiple values.
integer
Maximum number of booking updates to return (default: 1000, max: 1000).
string
Sort order for results. Format: ‘field.direction’ where direction is ‘asc’ or ‘desc’. Example: ‘created_at.desc’ for newest first.
integer
Number of booking updates to skip before starting to return results (for pagination).
string
Comma-separated list of columns to retrieve. Use ’*’ for all columns. Example: ‘id,booking_id,created_at’.
string
Filter by user ID using PostgREST operators. Supports null values. Example: ‘eq.uuid-value’, ‘is.null’ for null values.
string
Filter by booking ID using PostgREST operators. Example: ‘eq.uuid-value’ for exact match.
string
Filter by creation timestamp using PostgREST operators. Example: ‘gte.2024-01-01T00:00:00Z’ for dates on or after, ‘lte.2024-12-31T23:59:59Z’ for dates on or before.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CALENDAR_EVENT_NOTESTool to list calendar event notes with filtering and pagination. Use when you need to retrieve notes attached to calendar events, optionally filtered by author, event, timestamps, or content. Supports PostgREST filter operators for advanced querying.

Input Parameters

string
Filter by unique identifier of the calendar event note. Supports PostgREST filter operators (e.g., ‘eq.uuid’, ‘in.(uuid1,uuid2)’).
string
Filter by note content. Supports PostgREST filter operators (e.g., ‘ilike.search_term’ for case-insensitive pattern matching).
integer
Maximum number of calendar event notes to return (for pagination).
string
Sort results by specified column(s). Format: ‘column_name.asc’ or ‘column_name.desc’ (e.g., ‘created_at.desc’, ‘id.asc’).
integer
Number of calendar event notes to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all fields or comma-separated field names (e.g., ‘id,note,calendar_event_id,created_at’). If not specified, returns all fields by default.
string
Filter by identifier of the user that created the note. Supports PostgREST filter operators. Can be null.
string
Filter by creation timestamp. Supports PostgREST filter operators (e.g., ‘gte.2024-01-01T00:00:00Z’, ‘lte.2024-12-31T23:59:59Z’).
string
Filter by last modification timestamp. Supports PostgREST filter operators (e.g., ‘gte.2024-01-01T00:00:00Z’).
string
Filter by identifier of the related calendar event. Supports PostgREST filter operators (e.g., ‘eq.uuid’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CALENDAR_EVENTSTool to list calendar events with filtering and pagination. Use this to retrieve events visible on the timeline (bookings, blocked periods, notes), optionally filtering by status, type, date ranges, or other criteria. Supports PostgREST-style filtering and pagination via limit/offset parameters.

Input Parameters

string
Filter by calendar event ID. Supports PostgREST operators (e.g., ‘eq.uuid’, ‘in.(uuid1,uuid2)’).
string
Filter by event type. Supports PostgREST operators (e.g., ‘eq.booking’, ‘in.(booking,note)’).
integer
Maximum number of results to return (max: 1000).
string
Sort results by specified column. Use format ‘column_name.asc’ or ‘column_name.desc’ (e.g., ‘start_date.asc’).
string
Filter by event title. Supports PostgREST operators (e.g., ‘like.keyword’).
integer
Number of results to skip for pagination.
string
Specifies which columns to retrieve. Use ’*’ for all columns or comma-separated column names (e.g., ‘id,title,status’).
string
Filter by status. Supports PostgREST operators (e.g., ‘eq.CONFIRMED’, ‘in.(CONFIRMED,TENTATIVE)’).
string
Filter by end date. Supports PostgREST operators (e.g., ‘gte.2026-01-01’, ‘lte.2026-12-31’).
string
Filter by booking ID. Supports PostgREST operators (e.g., ‘eq.uuid’, ‘is.null’).
string
Filter by creation timestamp. Supports PostgREST operators (e.g., ‘gte.2026-01-01T00:00:00Z’).
string
Filter by product (unit) ID. Supports PostgREST operators.
string
Filter by start date. Supports PostgREST operators (e.g., ‘gte.2026-01-01’, ‘lte.2026-12-31’).
string
Filter by last update timestamp. Supports PostgREST operators.
string
Filter by organization ID. Supports PostgREST operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CALENDAR_EVENT_TASKSTool to list calendar event tasks with filtering and pagination. Use this to retrieve tasks associated with calendar events, optionally filtering by calendar event ID, completion status, due dates, or schedule type. Supports PostgREST-style filtering and pagination via limit/offset parameters.

Input Parameters

string
Filter by task ID. Supports PostgREST operators (e.g., ‘eq.uuid’, ‘in.(uuid1,uuid2)’).
string
Filter by task label. Supports PostgREST operators (e.g., ‘like.keyword’).
integer
Maximum number of results to return (max: 1000).
string
Sort results by specified column. Use format ‘column_name.asc’ or ‘column_name.desc’ (e.g., ‘created_at.desc’).
string
Filter by due date. Supports PostgREST operators (e.g., ‘lte.2024-12-31T23:59:59Z’).
integer
Number of results to skip for pagination.
string
Specifies which columns to retrieve. Use ’*’ for all columns or comma-separated column names (e.g., ‘id,label,due_at’).
string
Filter by schedule type. Supports PostgREST operators (e.g., ‘eq.manual’, ‘in.(arrival,departure)’).
string
Filter by creation timestamp. Supports PostgREST operators.
string
Filter by last update timestamp. Supports PostgREST operators.
string
Filter by completion timestamp. Supports PostgREST operators (e.g., ‘is.null’, ‘gte.2024-01-01T00:00:00Z’).
string
Filter by product task ID. Supports PostgREST operators.
string
Filter by calendar event ID. Supports PostgREST operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CALENDAR_EVENT_UPDATESLists calendar event updates, including status, product and interval changes, with pagination, column selection and ordering.

Input Parameters

integer
Maximum number of results to return (max 1000).
string
Column(s) to order results by using PostgREST syntax (e.g., ‘created_at.desc’ for descending order).
integer
Number of results to skip for pagination.
string
Columns to retrieve using PostgREST syntax (e.g., ‘select=*’ for all columns). Allows selecting specific fields from the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CAPACITIESList booking capacities with filtering and pagination. Use this to retrieve capacity configurations that define booking limits for products and capacity groups. Supports filtering by ID, capacity group, or product, as well as column selection, pagination, and sorting.

Input Parameters

string
Filter capacities by unique identifier. Returns only the capacity with this specific UUID.
integer
Maximum number of capacities to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘max.asc’. If not specified, returns in default order.
integer
Number of capacities to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,capacity_group_id,max’). If not specified, returns all columns by default.
string
Filter capacities by product identifier. Returns all capacities associated with this product.
string
Filter capacities by capacity group identifier. Returns all capacities belonging to this group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CAPACITY_GROUP_DEPSList capacity group dependencies representing relationships between accumulator and element capacity groups, with column selection, sorting, and pagination.

Input Parameters

integer
Maximum number of capacity group dependencies to return per request (1-1000). API maximum is 1000.
string
Sort order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘id.asc’).
integer
Number of capacity group dependencies to skip before returning results. Used for pagination.
string
Query parameter to specify which fields to return. Use ’*’ for all fields or comma-separated field names (e.g., ‘id,accumulator_id,element_id,created_at’). If not specified, returns all fields by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CAPACITY_GROUPSTool to list capacity groups with filtering and pagination. Use when you need to retrieve capacity group configurations, which define how guest capacity is managed and grouped. Supports filtering by various attributes and pagination for large result sets.

Input Parameters

string
Filter by unique identifier (UUID).
string
Filter by localized name (MultiLanguageString).
string ("manual" | "sum")
Filter by capacity group type: ‘manual’ or ‘sum’.
integer
Maximum number of capacity groups to return (default: 1000, max: 1000).
integer
Number of capacity groups to skip before starting to return results (for pagination).
string
Specify which columns to retrieve (supports ’*’ or comma-separated column names).
string
Sorting specification for results (e.g., ‘created_at.desc’, ‘name.asc’).
string
Filter by creation timestamp.
string
Filter by last modification timestamp.
string
Filter by localized description (MultiLanguageString).
string
Filter by localized singular name (MultiLanguageString).
string
Filter by related organization UUID.
boolean
Filter by whether explicit guest input is needed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CONTACT_BOOKINGSLists associations between contacts and bookings with pagination, column selection and sorting.

Input Parameters

integer
Maximum number of contact bookings to return (default: 1000, max: 1000).
string
Sorting parameter (e.g., ‘created_at.desc’ for descending by creation date).
integer
Number of contact bookings to skip before starting to return results (for pagination).
string
Columns to retrieve, can include related resources. Use ’*’ for all columns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_CONTACTSList customer contacts with column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of contacts to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘name.asc’). Can specify multiple columns separated by commas.
integer
Number of contacts to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,name,email’). Use ’*’ to select all columns. If not specified, all columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_COUPON_PRODUCTSList coupon products that define which products a coupon applies to. Use this when you need to retrieve product-coupon linkages, especially when coupon.scope is ‘rent’ or ‘product’. Supports PostgREST-style filtering on all fields (id, coupon_id, product_id, created_at), selection, sorting, and pagination.

Input Parameters

string
Filter by coupon product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of coupon products to return (max: 1000).
string
Sort results by field. Use PostgREST syntax like ‘created_at.desc’ or ‘id.asc’. Can sort by: id, coupon_id, product_id, created_at.
integer
Number of coupon products to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all fields or comma-separated column names like ‘id,coupon_id,product_id’. If not specified, returns all columns.
string
Filter by coupon ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all products linked to a specific coupon.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all coupons linked to a specific product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_COUPONSTool to list discount coupons with filtering and pagination. Use this when you need to retrieve coupons from the system, search by code or scope, or paginate through coupon records. Supports PostgREST-style filtering on all fields including code, scope, stackable status, quota, and timestamps.

Input Parameters

string
Filter by coupon ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Full-text search filter using PostgREST operators for text vector search.
string
Filter by coupon code using PostgREST operators. Examples: ‘eq.SAVE20’ (equals), ‘like.SAVE’ (contains).
integer
Maximum number of coupons to return (max: 1000).
string
Sort results by field. Use PostgREST syntax like ‘created_at.desc’ or ‘id.asc’. Can sort by any field.
string
Filter by quota using PostgREST operators. Examples: ‘gte.10’ (greater than or equal), ‘is.null’ (no quota limit).
string
Filter by coupon scope using PostgREST operators. Examples: ‘eq.global’ (equals), ‘in.(global,product)’ (in list). Valid scopes: global, product, service, rent.
integer
Number of coupons to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all fields or comma-separated column names like ‘id,code,scope’. If not specified, returns all columns.
string
Filter by stackable status using PostgREST operators. Examples: ‘eq.true’ (stackable), ‘eq.false’ (non-stackable).
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by coupon definition (PriceExpression) using PostgREST operators.
string
Filter by deletion timestamp using PostgREST operators. Examples: ‘is.null’ (not deleted), ‘not.is.null’ (deleted).
string
Filter by last update timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal).
string
Filter by coupon description using PostgREST operators. Examples: ‘like.discount’ (contains).
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_COUPON_SERVICESList coupon services that define which services a coupon applies to. Use this when you need to retrieve service-coupon linkages, especially when coupon.scope is ‘service’. Supports PostgREST-style filtering on all fields (id, coupon_id, service_id, created_at), selection, sorting, and pagination.

Input Parameters

string
Filter by coupon service ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of coupon services to return (max: 1000).
string
Sort results by field. Use PostgREST syntax like ‘created_at.desc’ or ‘id.asc’. Can sort by: id, coupon_id, service_id, created_at.
integer
Number of coupon services to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all fields or comma-separated column names like ‘id,coupon_id,service_id’. If not specified, returns all columns.
string
Filter by coupon ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all services linked to a specific coupon.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by service ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all coupons linked to a specific service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_COUPON_USESList coupon uses that track which coupons have been applied to bookings. Use this when you need to retrieve coupon usage history, audit coupon applications, or track which bookings used specific coupons. Supports PostgREST-style filtering on all fields (id, booking_id, coupon_id, created_at), selection, sorting, and pagination.

Input Parameters

string
Filter by coupon use ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of coupon uses to return (max: 1000).
string
Sort results by field. Use PostgREST syntax like ‘created_at.desc’ or ‘id.asc’. Can sort by: id, booking_id, coupon_id, created_at.
integer
Number of coupon uses to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all fields or comma-separated column names like ‘id,booking_id,coupon_id,created_at’. If not specified, returns all columns.
string
Filter by coupon ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all uses of a specific coupon.
string
Filter by booking ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all coupon uses for a specific booking.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_EMAIL_EVENTSTool to retrieve email events (bounce, delivery, open) with filtering and pagination. Use this to track email delivery status, monitor bounces, or analyze email engagement. Supports PostgREST-style filtering on event type, email address, timestamps, and other criteria.

Input Parameters

string
Filter by email event ID. Supports PostgREST operators (e.g., ‘eq.uuid’, ‘in.(uuid1,uuid2)’).
integer
Maximum number of results to return (max: 1000).
string
Sort results by specified column. Use format ‘column_name.asc’ or ‘column_name.desc’ (e.g., ‘created_at.desc’).
integer
Number of results to skip for pagination.
string
Specifies which columns to retrieve. Use ’*’ for all columns or comma-separated column names (e.g., ‘id,email_id,event_type’).
string
Filter by related email ID. Supports PostgREST operators (e.g., ‘eq.uuid’, ‘is.null’).
string
Filter by event creation timestamp. Supports PostgREST operators (e.g., ‘gte.2026-01-01T00:00:00Z’, ‘lte.2026-12-31T23:59:59Z’).
string
Filter by event type. Supports PostgREST operators (e.g., ‘eq.delivered’, ‘in.(bounce,dropped)’).
string
Filter by recipient email address. Supports PostgREST operators (e.g., ‘eq.user@example.com’, ‘like.*@example.com’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_EMAILSTool to retrieve emails from the system with optional filtering and pagination. Returns a list of email records including details like subject, body, status, scheduled send time, and related booking information. Use this when you need to list emails, search by booking or status, or paginate through email records.

Input Parameters

string
Filter emails by exact ID match.
string ("email" | "sms")
Email type values.
integer
Maximum number of emails to return per request. Default and maximum is 1000.
string
Sort order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘send_at.asc’).
integer
Number of emails to skip before returning results. Used for pagination.
string
Columns to retrieve from emails table. Use ’*’ for all columns, or specify comma-separated field names (e.g., ‘id,subject,status,created_at’). Can include related resource columns.
string ("manually-scheduled" | "scheduled-around-arrival" | "scheduled-around-departure" | "sent")
Email status values.
string
Filter emails by related booking identifier.
string
Filter emails by associated calendar event identifier.
string
Filter emails by base email template reference.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_EMAIL_TEMPLATESList email template configurations used for booking notifications, with column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of email templates to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘title.asc’). Can specify multiple columns separated by commas.
integer
Number of email templates to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,title,subject’). Use ’*’ to select all columns. If not specified, all columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_EXTERNAL_CALENDARSTool to list external calendar sync configurations (e.g., Google Calendar, iCal). Use this to retrieve all external calendars with optional filtering and pagination. Supports PostgREST-style filtering for querying specific calendars by name, type, or organization.

Input Parameters

string
Filter by external calendar ID. Supports PostgREST operators (e.g., ‘eq.uuid’, ‘in.(uuid1,uuid2)’).
string
Filter by calendar name. Supports PostgREST operators (e.g., ‘like.keyword’).
string
Filter by calendar type. Supports PostgREST operators (e.g., ‘eq.google’, ‘eq.ical’).
integer
Maximum number of results to return (max: 1000).
string
Sort results by specified column. Use format ‘column_name.asc’ or ‘column_name.desc’ (e.g., ‘created_at.desc’).
integer
Number of results to skip for pagination.
string
Specifies which columns to retrieve. Use ’*’ for all columns or comma-separated column names (e.g., ‘id,name,type’).
string
Filter by creation timestamp. Supports PostgREST operators (e.g., ‘gte.2026-01-01T00:00:00Z’).
string
Filter by last update timestamp. Supports PostgREST operators.
string
Filter by organization ID. Supports PostgREST operators (e.g., ‘eq.uuid’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_INVOICESTool to retrieve invoices from the system with optional filtering and pagination. Returns a list of invoice records including amounts, statuses, and payment information. Use this when you need to list invoices, search by organization, or paginate through invoice records.

Input Parameters

string
Filter invoices by exact ID match.
integer
Maximum number of invoices to return per request. Default and maximum is 1000.
string
Sort order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘amount.asc’).
integer
Number of invoices to skip before returning results. Used for pagination.
string
Columns to retrieve from invoices table. Use ’*’ for all columns, or specify comma-separated field names (e.g., ‘id,organization_id,created_at’). Can include related resource columns.
string
Filter invoices by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_LINE_ITEMSTool to retrieve line items from the system with optional filtering and pagination. Returns a list of line item records including details like quantities, amounts, unit prices, and related booking/product/service information. Use this when you need to list line items, search by booking or product, or paginate through line item records.

Input Parameters

string
Filter by line item ID (UUID). Supports PostgREST operators (e.g., ‘eq.uuid-value’).
integer
Maximum number of line items to return per request. Default and maximum is 1000.
string
Sort order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘amount.asc’).
integer
Number of line items to skip before returning results. Used for pagination.
string
Specify which columns to retrieve from line_items table. Use ’*’ for all columns, or specify comma-separated field names (e.g., ‘id,booking_id,amount,quantity’).
string
Filter by booking ID (UUID). Returns all line items for the specified booking. Supports PostgREST operators.
string
Filter by product ID (UUID). Returns all line items for the specified product. Supports PostgREST operators.
string
Filter by service ID (UUID). Returns all line items for the specified service. Supports PostgREST operators.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_LINE_ITEM_TAXESList tax records applied to booking line items, with column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of line item taxes to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘amount.asc’). Can specify multiple columns separated by commas.
integer
Number of line item taxes to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,amount,percentage’). Use ’*’ to select all columns. If not specified, all columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_MEMBERSList organization members with column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of members to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘name.asc’). Can specify multiple columns separated by commas.
integer
Number of members to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,name,email,role’). Use ’*’ to select all columns. If not specified, all columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_ORGANIZATIONSTool to list organizations. Use when you need to retrieve all organizations accessible by the current API key.

Input Parameters

integer
Maximum number of organizations to return per request (1-1000). API maximum is 1000.
string
Sort order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘name.asc’).
integer
Number of organizations to skip before returning results. Used for pagination.
string
Columns to retrieve. Use ’*’ for all columns, or specify comma-separated field names (e.g., ‘id,name,created_at’). If not specified, returns all columns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PADDLE_SUBSCRIPTIONSList Paddle subscriptions with PostgREST-style filtering by ID, organization, status, or timestamps, plus column selection, sorting, and pagination.

Input Parameters

string
Filter by subscription ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of subscriptions to return (max: 1000).
string
Sort results by field. Use PostgREST syntax like ‘created_at.desc’ or ‘id.asc’. Can sort by any field.
integer
Number of subscriptions to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all fields or comma-separated column names like ‘id,status,organization_id’. If not specified, returns all columns.
string
Filter by subscription status using PostgREST operators. Examples: ‘eq.active’ (equals), ‘in.(active,cancelled)’ (in list).
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by last update timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal).
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PAYMENTSList payment transactions with optional ID or invoice filtering, column selection, sorting, and pagination. Payment records may include amounts, statuses, payment methods, and transaction details.

Input Parameters

string
Filter payments by exact ID match.
integer
Maximum number of payments to return per request. Default and maximum is 1000.
string
Sort order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘amount.asc’).
integer
Number of payments to skip before returning results. Used for pagination.
string
Columns to retrieve from payments table. Use ’*’ for all columns, or specify comma-separated field names (e.g., ‘id,amount,currency,status’). Can include related resource columns.
string
Filter payments by invoice ID to find all payments associated with a specific invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PERMISSIONSTool to list permissions with filtering and pagination. Supports PostgREST query parameters for column selection, ordering, and pagination. Use this to retrieve user permissions for products in the system.

Input Parameters

string
Filter by permission UUID. Use PostgREST operators like ‘eq’, ‘neq’, ‘in’. Example: ‘eq.00000000-0000-0000-0000-000000000001’.
integer
Maximum number of permissions to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘user_id.asc’). Can specify multiple columns separated by commas.
integer
Number of permissions to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,user_id,product_id’). Use ’*’ to select all columns. If not specified, all columns are returned.
string
Filter by user UUID. Use PostgREST operators like ‘eq’, ‘neq’, ‘in’. Example: ‘eq.11111111-2222-3333-4444-555555555555’.
string
Filter by product UUID. Use PostgREST operators like ‘eq’, ‘neq’, ‘in’. Example: ‘eq.66666666-7777-8888-9999-000000000000’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PRICING_WIDGETSList pricing widget configurations with PostgREST-style filtering by ID or organization, column selection, pagination, and sorting.

Input Parameters

string
Filter by pricing widget ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of pricing widgets to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘name.asc’). Can specify multiple columns separated by commas.
integer
Number of pricing widgets to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,organization_id’). Use ’*’ to select all columns. If not specified, all columns are returned.
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all pricing widgets belonging to a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PRODUCT_ATTR_OPTIONSList product attribute options with filtering and pagination. Use this to retrieve which attribute options are available for specific products, enabling product customization through attribute selection. Supports PostgREST-style filtering on all fields (id, product_id, attribute_option_id, timestamps), column selection, pagination, and sorting.

Input Parameters

string
Filter by product attribute option ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of results to return per request (1-1000). API maximum is 1000 results.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘product_id.asc’. If not specified, returns in default order.
integer
Number of results to skip for pagination.
string
Specify which columns to retrieve. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,product_id,attribute_option_id’). If not specified, returns all columns by default.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all attribute options available for a specific product.
string
Filter by last modification timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by attribute option ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find which products have a specific attribute option.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PRODUCT_CALENDAR_LOGSLists product calendar log records with pagination and PostgREST-style filters for ID, product, organization and creation time.

Input Parameters

string
Filter by log entry ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of results to return (max: 1000).
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘product_id.asc’.
integer
Number of results to skip for pagination.
string
Specify which columns to retrieve using PostgREST syntax. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,product_id,created_at’). Can also include related resources.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all calendar logs for a specific product.
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PRODUCT_CONFIGSList product configurations with PostgREST-style filtering by ID, product, or timestamps, plus column selection, pagination, and sorting.

Input Parameters

string
Filter by product configuration ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of product configurations to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘product_id.asc’. If not specified, returns in default order.
integer
Number of product configurations to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use '' for all columns, or provide comma-separated column names (e.g., ‘id,product_id,organization_id’). Can also include related resources (e.g., ‘product_id,product()’). If not specified, returns all columns by default.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find configurations for a specific product.
string
Filter by last modification timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PRODUCT_REPLY_ADDRSList product reply-to addresses with PostgREST-style column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of product reply-to addresses to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘email.asc’. If not specified, returns in default order.
integer
Number of product reply-to addresses to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,email,product_id’). If not specified, returns all columns by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PRODUCTSList bookable products with PostgREST-style filtering by ID, organization, name, or timestamps, plus column selection, pagination, and sorting.

Input Parameters

string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by product name using PostgREST operators. Examples: ‘like.cabin’ (contains), ‘ilike.CABIN’ (case-insensitive contains).
integer
Maximum number of products to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘name.asc’. If not specified, returns in default order.
integer
Number of products to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use '' for all columns, or provide comma-separated column names (e.g., ‘id,name,organization_id’). Can also include related resources (e.g., ‘name,capacities()’). If not specified, returns all columns by default.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by last modification timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all products belonging to a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PRODUCT_SERVICESList product services that define which services are linked to which products. Use this when you need to retrieve product-service associations. Supports PostgREST-style filtering on all fields (id, product_id, service_id, created_at), selection, sorting, and pagination.

Input Parameters

string
Filter by product service ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
integer
Maximum number of product services to return (max: 1000).
string
Sort results by field. Use PostgREST syntax like ‘created_at.desc’ or ‘id.asc’. Can sort by: id, product_id, service_id, created_at.
integer
Number of product services to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all fields or comma-separated column names like ‘id,product_id,service_id’. If not specified, returns all columns.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all services linked to a specific product.
string
Filter by service ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all products linked to a specific service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_PRODUCT_TASKSList product task configurations with column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of product tasks to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘label.asc’). Can specify multiple columns separated by commas.
integer
Number of product tasks to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,label,product_id’). Use ’*’ to select all columns. If not specified, all columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_REPLY_TO_ADDRESSESList reply-to addresses configured for communications with PostgREST-style column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of reply-to addresses to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘email.asc’. If not specified, returns in default order.
integer
Number of reply-to addresses to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,email,name,organization_id’). If not specified, returns all columns by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_REVIEW_PRODUCTSList review product records with column selection, pagination, and sorting.

Input Parameters

integer
Maximum number of review products to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘name.asc’. If not specified, returns in default order.
integer
Number of review products to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,name,product_id’). Can also include related resources. If not specified, returns all columns by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_REVIEWSList customer reviews, including ratings, comments, and associated booking or product information. Supports column selection, pagination, and sorting.

Input Parameters

integer
Maximum number of reviews to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘rating.asc’. Multiple columns can be specified separated by commas.
integer
Number of reviews to skip before starting to return results (for pagination).
string
Specify which columns to retrieve from the reviews resource. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,rating,comment,created_at’). Can also include related resource columns. If not specified, returns all columns by default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_REVIEW_WIDGET_LISTINGSList review widget listing associations with column selection, sorting, and pagination.

Input Parameters

integer
Maximum number of records to return for pagination. API maximum is 1000 results per request.
string
Column name to sort by with optional direction. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘listing_id.asc’). If not specified, returns in default order.
integer
Number of records to skip for pagination. Use with limit for paginating through results.
string
Comma-separated list of columns to retrieve. Use ’*’ for all columns or specify individual column names (e.g., ‘id,review_widget_id,listing_id’). Can include related resource columns. If not specified, returns all columns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_REVIEW_WIDGETSTool to retrieve review widgets from the system with optional filtering and pagination. Returns a list of review widget configurations including their IDs, names, and organization associations. Use this when you need to list review widgets, search by name or organization, or paginate through review widget records.

Input Parameters

string
Filter review widgets by exact ID match.
string
Filter review widgets by name.
integer
Maximum number of review widgets to return per request. Default and maximum is 1000.
string
Sort order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘name.asc’).
integer
Number of review widgets to skip before returning results. Used for pagination.
string
Columns to retrieve from review_widgets table. Use ’*’ for all columns, or specify comma-separated field names (e.g., ‘id,name,created_at’). Can include related resource columns.
string
Filter review widgets by organization ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_SEASONSList seasons with filtering and pagination. Use this to retrieve seasonal pricing periods that define price variations for different times of the year. Supports PostgREST-style filtering on all fields (id, organization_id, name, timestamps), column selection, pagination, and sorting.

Input Parameters

string
Filter by season ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by season name using PostgREST operators. Examples: ‘like.summer’ (contains), ‘ilike.SUMMER’ (case-insensitive contains).
integer
Maximum number of seasons to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘name.asc’, ‘start_date.asc’. If not specified, returns in default order.
integer
Number of seasons to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,name,organization_id’). If not specified, returns all columns by default.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by last modification timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all seasons belonging to a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_SERVICESList bookable services with filtering and pagination. Use this to retrieve service configurations that define activities, treatments, or other bookable services in the system. Supports PostgREST-style filtering on all fields (id, organization_id, name, timestamps), column selection, pagination, and sorting.

Input Parameters

string
Filter by service ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by service name using PostgREST operators. Examples: ‘like.massage’ (contains), ‘ilike.MASSAGE’ (case-insensitive contains).
integer
Maximum number of services to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘name.asc’, ‘order.asc’. If not specified, returns in default order.
integer
Number of services to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use '' for all columns, or provide comma-separated column names (e.g., ‘id,name,organization_id’). Can also include related resources (e.g., ‘name,products()’). If not specified, returns all columns by default.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by last modification timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all services belonging to a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_SITE_LISTINGSList site listing records with column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of results to return (default: 1000, max: 1000).
string
Specify sorting order for results. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘name.asc’).
integer
Number of results to skip for pagination.
string
Specify columns to retrieve. Use ’*’ for all columns or comma-separated column names (e.g., ‘id,organization_id,created_at’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_SITE_NAV_ITEMSList site navigation items with field selection, ordering, and pagination to retrieve navigation menu entries.

Input Parameters

integer
Maximum number of site navigation items to return (default: 1000, max: 1000).
string
Order results by field(s). Format: ‘field.asc’ or ‘field.desc’ (e.g., ‘order=created_at.desc’ or ‘order=label.asc’).
integer
Number of site navigation items to skip before starting to return results (for pagination).
string
Query parameter to filter which fields to return (e.g., ‘select=*’ to return all fields, or ‘select=id,label’ for specific fields).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_SITE_PAGESList site pages with column selection, sorting, and pagination.

Input Parameters

integer
Maximum number of site pages to return per request. Default and maximum is 1000.
string
Sort order for results using PostgREST syntax. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘path.asc’).
integer
Number of site pages to skip before returning results. Used for pagination.
string
Comma-separated list of columns to retrieve. Use ’*’ for all columns, or specify field names (e.g., ‘id,title,path,status’). Can include related resource columns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_SITESList sites with PostgREST column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of sites to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘name.asc’). Can specify multiple columns separated by commas.
integer
Number of sites to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,name,address’). Use ’*’ to select all columns. If not specified, all columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_SITE_VIEWSList site views with column selection, ordering, and pagination. Retrieve site traffic records to analyze visitor behavior or track page views over time.

Input Parameters

integer
Maximum number of site views to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘site_id.asc’). Can specify multiple columns separated by commas.
integer
Number of site views to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,site_id,created_at’). Use ’*’ to select all columns. If not specified, all columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_TAXESList tax configurations such as VAT, sales tax, and GST with PostgREST-style filters, column selection, pagination, and sorting.

Input Parameters

string
Filter by tax ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list).
string
Filter by tax name using PostgREST operators. Examples: ‘like.VAT’ (contains), ‘ilike.vat’ (case-insensitive contains), ‘eq.Sales Tax’ (exact match).
integer
Maximum number of taxes to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘created_at.desc’, ‘name.asc’. If not specified, returns in default order.
integer
Number of taxes to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘id,name,percentage’). If not specified, returns all columns by default.
string
Filter by creation timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by last modification timestamp using PostgREST operators. Examples: ‘gte.2024-01-01T00:00:00Z’ (greater than or equal), ‘lt.2024-12-31T23:59:59Z’ (less than).
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to find all taxes belonging to a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_USER_PROFILESList all user profiles accessible by the current API key. Returns user profile information including IDs, names, email addresses, and organization associations. Use this to discover users in the system before performing operations or assigning resources. Supports pagination via limit and offset parameters.

Input Parameters

integer
Maximum number of user profiles to return (default: 1000, max: 1000).
integer
Number of user profiles to skip before starting to return results (for pagination).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_WEBHOOK_NOTIFICATIONSList webhook notification records with pagination, including status, event types, and delivery information for monitoring and troubleshooting.

Input Parameters

integer
Maximum number of webhook notifications to return.
integer
Number of webhook notifications to skip before starting to return results (for pagination).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_WEBHOOKSList webhook configurations with column selection, ordering, and pagination. Retrieve webhook endpoints and their URLs, subscribed events, and status for integration management or debugging.

Input Parameters

integer
Maximum number of webhooks to return (max: 1000).
string
Column(s) to sort by, with optional direction (e.g., ‘created_at.desc’, ‘url.asc’). Can specify multiple columns separated by commas.
integer
Number of webhooks to skip before starting to return results (for pagination).
string
Comma-separated list of columns to return (e.g., ‘id,url,events’). Use ’*’ to select all columns. If not specified, all columns are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_WIDGET_ANALYTICSTool to list widget analytics with pagination. Returns metrics and statistics for widgets including views, bookings, conversion rates, and revenue data. Supports pagination via limit and offset parameters.

Input Parameters

integer
Maximum number of analytics records to return (max: 1000).
integer
Number of analytics records to skip before starting to return results (for pagination).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_WIDGET_LISTINGSList widget listing associations with column selection, ordering, and pagination.

Input Parameters

integer
Maximum number of records to return for pagination. API maximum is 1000 results per request.
string
Column name to sort by with optional direction. Format: ‘column.direction’ where direction is ‘asc’ or ‘desc’ (e.g., ‘created_at.desc’, ‘listing_id.asc’). If not specified, returns in default order.
integer
Number of records to skip for pagination. Use with limit for paginating through results.
string
Comma-separated list of columns to retrieve. Use ’*’ for all columns or specify individual column names (e.g., ‘id,widget_id,listing_id’). Can include related resource columns. If not specified, returns all columns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_LIST_WIDGETSList all booking widgets accessible by the current API key. Returns widget configurations including their IDs, names, types, and organization associations. Use this to discover available widgets before performing operations like searching availability or managing bookings. Supports pagination via limit and offset parameters.

Input Parameters

integer
Maximum number of widgets to return (default: 1000, max: 1000).
integer
Number of widgets to skip before starting to return results (for pagination).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_QUERY_AVAILABILITYTool to fetch availability of multiple products over a long period of time. Use this to check when products can be booked by querying availability records. Supports PostgREST-style filtering on product ID, date ranges, and availability status, plus pagination via limit/offset parameters.

Input Parameters

integer
Maximum number of availability records to return (1-1000). API maximum is 1000 results per request.
string
Sort results by specified column and direction. Format: ‘column_name.direction’ where direction is ‘asc’ or ‘desc’. Examples: ‘start_date.asc’, ‘product_id.desc’. If not specified, returns in default order.
integer
Number of availability records to skip before starting to return results (for pagination).
string
Specify which columns to retrieve. Use ’*’ for all columns, or provide comma-separated column names (e.g., ‘product_id,start_date,end_date,available’). If not specified, returns all columns by default.
string
Filter by end date using PostgREST operators. Examples: ‘lte.2026-12-31’ (less than or equal), ‘eq.2026-03-01’ (equals). Use to find availability ending before or on a specific date.
string
Filter by availability status using PostgREST operators. Examples: ‘eq.true’ (only available), ‘eq.false’ (only unavailable).
string
Filter by product ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals), ‘in.(uuid1,uuid2)’ (in list). Use this to query availability for specific product(s).
string
Filter by start date using PostgREST operators. Examples: ‘gte.2026-01-01’ (greater than or equal), ‘eq.2026-02-15’ (equals). Use to find availability starting from or on a specific date.
string
Filter by organization ID using PostgREST operators. Examples: ‘eq.uuid-value’ (equals). Use this to query availability for products in a specific organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_ATTRIBUTE_OPTIONSUpdate attribute option records matching the supplied filters, modifying localized names, display order, or parent attribute association. An empty filter can update all accessible attribute options.

Input Parameters

object
required
Data to update on the matched attribute options.
object
required
Filters to select which attribute options to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_ATTRIBUTESUpdates attribute records that match the specified filters. Attributes define custom properties for bookings (e.g., room type, amenities). At least one filter must be provided to target specific records. Use this to modify the localized name, display order, or attribute type. Typically used with the ‘id’ filter to update a specific attribute.

Input Parameters

object
required
Data to update on the matched attributes. At least one field must be provided.
string
Comma-separated list of columns to return in the response (e.g., ‘id,name,order’). If not specified, all columns are returned.
object
required
Filters to select attributes to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_BOOKING_DETAILSUpdates booking detail records that match the specified filters. Booking details store guest-filled form field data such as names, contact info, and custom field values. At least one filter must be provided to target specific records. Use this to modify attachment URLs, localized field names, descriptions, or customer-provided values.

Input Parameters

object
required
Data to update on the matched booking details.
object
required
Filters to select booking details to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_BOOKINGSUpdates booking records that match the specified filters. Bookings represent customer reservations with metadata such as currency, references, confirmation status, and silent mode. At least one filter must be provided to target specific records. Use this to modify booking attributes like confirmation timestamp, currency settings, or booking references.

Input Parameters

object
required
Data to update on the matched bookings.
object
required
Filters to select bookings to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_CALENDAR_EVENT_NOTESUpdates calendar event note records that match the specified filters. Use this to modify notes associated with calendar events. At least one filter must be provided to target specific records.

Input Parameters

object
required
Data to update on the matched calendar event notes.
object
required
Filters to select calendar event notes to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_CALENDAR_EVENTSUpdate existing calendar events that match the specified filters. Use this to modify event status (CANCELLED, TENTATIVE, CONFIRMED), notes, title, or dates. At least one filter must be provided to target specific events. Commonly used to confirm tentative bookings or add notes to existing events.

Input Parameters

object
required
Data to update on the matched calendar events.
object
required
Filters to select calendar events to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_CALENDAR_EVENT_TASKSTool to update existing calendar event tasks. Use when you need to modify task details such as labels, completion status, due dates, or schedule information.

Input Parameters

string
UUID of the calendar event task to update
string
Label for the task
string
Timestamp when task is due (ISO 8601)
string
Schedule type for the task
string
Timestamp when task was completed (ISO 8601)
string
UUID of the associated product task
string
UUID of the associated calendar event
string
Timestamp when notification was sent (ISO 8601)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_CAPACITIESUpdates capacity records’ minimum or maximum occupancy thresholds using the specified filters. An empty filter can update all accessible capacity records.

Input Parameters

object
required
Data to update on the matched capacity records.
object
required
Filters to select capacities to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_CAPACITY_GROUP_DEPSUpdates capacity group dependency records, changing relationships between accumulating and accumulated capacity groups. An empty filter can update all accessible dependency records.

Input Parameters

object
required
Data to update on the matched capacity group dependencies.
object
required
Filters to select capacity group dependencies to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_CAPACITY_GROUPSUpdates capacity group names, descriptions, display order or capacity calculation settings. An empty filter can update all accessible capacity groups.

Input Parameters

object
required
Data to update on the matched capacity groups.
object
required
Filters to select capacity groups to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_CONTACT_BOOKINGSUpdates contact booking records linking contacts to bookings, including reassigning their contact or booking. An empty filter can update all accessible contact booking records.

Input Parameters

object
required
Data to update on the matched contact bookings. At least one field must be provided.
string
Comma-separated list of columns to return in the response (e.g., ‘id,booking_id,contact_id’). If not specified, all columns are returned.
object
required
Filters to select contact bookings to update. At least one filter must be provided to target specific records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_CONTACTSUpdates contact records that match the specified filters. Use this to modify existing contact information such as name, email, phone, address, company details, or custom metadata. At least one filter must be provided to target specific contacts.

Input Parameters

object
required
Data to update on the matched contacts.
object
required
Filters to select contacts to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_COUPON_PRODUCTSUpdates coupon product link records that match the specified filters. Use this to modify existing coupon-product associations by changing which coupon or product they link to. At least one filter must be provided to target specific records.

Input Parameters

object
required
Data to update on the matched coupon products.
object
required
Filters to select coupon products to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_COUPONSUpdates coupon records, including their code, description, definition, quota, scope or stackable status. An empty filter can update all accessible coupons.

Input Parameters

object
required
Data to update on the matched coupons.
string
Specify which columns to return in the response. Use ’*’ for all fields or comma-separated column names like ‘id,code,scope’. If not specified, returns empty response.
object
required
Filters to select coupons to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_COUPON_SERVICESUpdates coupon-service association records using the specified filters. An empty filter can update all accessible coupon-service records.

Input Parameters

object
required
Data to update on the matched coupon services.
object
required
Filters to select coupon services to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_COUPON_USESUpdates coupon use records, changing their associated booking or coupon. An empty filter can update all accessible coupon use records.

Input Parameters

object
required
Data to update on the matched coupon uses.
object
required
Filters to select coupon uses to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_EXTERNAL_CALENDARSUpdates external calendar names. Supply a filter to target a specific calendar; an empty filter can update all accessible calendars.

Input Parameters

object
required
Data to update on the matched external calendars.
object
required
Filters to select external calendars to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_LINE_ITEMSUpdates line item quantities, pricing, descriptions, or service and tax associations. Filters select records; an empty filter can update all accessible line items.

Input Parameters

object
required
Data to update on the matched line items.
object
required
Filters to select line items to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_LINE_ITEM_TAXESUpdates line item tax records’ amount or percentage using the specified filters. An empty filter can update all accessible line item tax records.

Input Parameters

object
required
Data to update on the matched line item taxes.
object
required
Filters to select line item taxes to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PAYMENTSUpdates payment amounts, currencies, or booking and invoice associations for records matching the supplied filters. At least one filter and one update field are required.

Input Parameters

object
required
Data to update on the matched payments.
object
required
Filters to select payments to update using PostgREST syntax. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PERMISSIONSUpdates product associations for permission records matching the supplied filters. An empty filter can update all accessible permissions.

Input Parameters

object
required
Data to update on the matched permissions.
object
required
Filters to select permissions to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PRICING_WIDGETSUpdates pricing widget names or localized translations for records matching the supplied filters. An empty filter can update all accessible pricing widgets.

Input Parameters

object
required
Data to update on the matched pricing widget records.
object
required
Filters to select pricing widgets to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PRODUCT_ATTRIBUTE_OPTIONSUpdates associations between products and attribute options matching the supplied filters. An empty filter can update all accessible product attribute options.

Input Parameters

object
required
Data to update on the matched product attribute options. At least one field must be provided.
string
Comma-separated list of columns to return in the response (e.g., ‘id,product_id,attribute_option_id’). Requires ‘Prefer: return=representation’ header.
object
required
Filters to select which product attribute options to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PRODUCT_CONFIGSUpdates the timestamp on product configuration records matching the supplied filters. An empty filter can update all accessible product configurations.

Input Parameters

object
required
Data to update on the matched product configuration records.
object
required
Filters to select product configurations to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PRODUCT_REPLY_TO_ADDRESSESUpdates associations between products and reply-to addresses matching the supplied filters. An empty filter can update all accessible associations.

Input Parameters

object
required
Data to update on the matched product reply-to address records. At least one field must be provided.
integer
Limit number of rows to update. Requires ‘order’ parameter to be set.
string
Ordering parameter for results (required when using limit). Format: ‘column.asc’ or ‘column.desc’.
string
Comma-separated list of columns to return after update (e.g., ‘id,product_id,reply_to_address_id’). Returns all columns if not specified.
object
required
Filters to select which product reply-to address records to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PRODUCTSUpdates product records matching the supplied filters, including localized names and descriptions. An empty filter can update all accessible products.

Input Parameters

object
required
Data to update on the matched products. At least one field must be provided.
string
Comma-separated list of columns to return in the response (e.g., ‘id,name,price’). If not specified, all columns are returned.
object
required
Filters to select products to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PRODUCT_SERVICESUpdates product-service associations matching the supplied filters. An empty filter can update all accessible product-service records.

Input Parameters

object
required
Data to update on the matched product_services records.
object
required
Filters to select product_services to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_PRODUCT_TASKSUpdates labels on product tasks matching the supplied filters. An empty filter can update all accessible product tasks.

Input Parameters

object
required
Data to update on the matched product tasks.
object
required
Filters to select product tasks to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_REVIEW_PRODUCTSUpdates the review linked to product association records matching the supplied filters. An empty filter can update all accessible review-product links.

Input Parameters

object
required
Data to update on the matched review products.
object
required
Filters to select review products to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_REVIEWSUpdates review ratings, comments, responses, status, or associated entities for records matching the supplied filters. An empty filter can update all accessible reviews.

Input Parameters

object
required
Data to update on the matched reviews.
object
required
Filters to select reviews to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_REVIEW_WIDGET_LISTINGSUpdates review widget-product associations matching the supplied filters. An empty filter can update all accessible review widget listings.

Input Parameters

object
required
Data to update on the matched review widget listings.
object
required
Filters to select review widget listings to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_REVIEW_WIDGETSUpdates the organization association on review widget records matching the supplied filters. An empty filter can update all accessible review widgets.

Input Parameters

object
required
Data to update on the matched review widgets.
object
required
Filters to select review widgets to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_SERVICESUpdates service descriptions or display order for records matching the supplied filters. An empty filter can update all accessible services.

Input Parameters

object
required
Data to update on the matched services.
object
required
Filters to select services to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_SITE_LISTINGSUpdates site listing product or site associations and display order for records matching the supplied filters. An empty filter can update all accessible site listings.

Input Parameters

object
required
Data to update on the matched site listings.
object
required
Filters to select site listings to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_SITE_NAV_ITEMSUpdates site navigation items, including labels, URLs, display order and parent relationships. Supply filters to target specific items; an empty filter can update all accessible items.

Input Parameters

object
required
Data to update on the matched site navigation items. At least one field must be provided.
object
required
Filters to select site navigation items to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_SITE_PAGESUpdates site page titles. Supply filters to target specific pages; an empty filter can update all accessible pages.

Input Parameters

object
required
Data to update on the matched site pages.
object
required
Filters to select site pages to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_SITESUpdates site names. Supply filters to target specific sites; an empty filter can update all accessible sites.

Input Parameters

object
required
Data to update on the matched site records. At least one field must be provided.
object
required
Filters to select sites to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_TAXESUpdates tax percentage rates. Supply filters to target specific taxes; an empty filter can update all accessible taxes.

Input Parameters

object
required
Data to update on the matched taxes.
object
required
Filters to select taxes to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_USER_PROFILESUpdates user profiles, including name, language, avatar and calendar settings. Supply filters to target specific profiles; an empty filter can update all accessible profiles.

Input Parameters

object
required
Data to update on the matched user profile records.
object
required
Filters to select user profiles to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_WEBHOOKSUpdates webhook URLs, event subscriptions, enabled status or descriptions. Supply filters to target specific webhooks; an empty filter can update all accessible webhooks.

Input Parameters

object
required
Data to update on the matched webhooks.
object
required
Filters to select webhooks to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_WIDGET_LISTINGSUpdates widget listings, including display order and widget-product associations. Supply filters to target specific listings; an empty filter can update all accessible listings.

Input Parameters

object
required
Data to update on the matched widget listings.
object
required
Filters to select widget listings to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOOKINGMOOD_UPDATE_WIDGETSUpdates booking widget configurations, including name, type, locale, currency, interaction and display settings. Supply filters to target specific widgets; an empty filter sends an unfiltered update.

Input Parameters

object
required
Data to update on the matched widgets.
object
required
Filters to select widgets to update. At least one filter must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not