Bookingmood integration guide
VerifiedHow to connect Bookingmood to WEXTL and use its 1 trigger and 148 actions in your workflows. About Bookingmood: Booking software for vacation rentals.
- 1 trigger
- 62 searches
- 86 actions
- Instant (webhooks)
- Auth: API key
- Auth: OAuth
AI-assisted documentation45 min read
This documentation is compiled from our integration source code, internal specs for Bookingmood, its official API documentation and anonymized requests logs we collect from our support team[2].
Requirements
Get your Bookingmood credentials
Bookingmood - API Key
- API KeypasswordRequired
In Bookingmood open Settings, then API keys, and create a key. Copy it now: it is shown once. Give it read and write access to the areas the workflow uses, and at least read access to the organization so the connection can be verified.[1]
Bookingmood
You’ll be redirected to sign in and approve access. Your password is never shared with WEXTL.
- Client IDtextRequired
Bookingmood has no developer console: register a public client once at https://www.bookingmood.com/oauth/register with the Callback URL shown in this connection form, and paste the client id you get back.[1]
- Client Secretpassword
Leave blank for a public client (PKCE protects the sign-in). Only a confidential client arranged with Bookingmood has a secret.[1]
Integration requests 13 permissions:
Read bookingsRead and change bookingsRead channelsRead and change channelsRead messagesRead and change messagesRead organizationRead and change organizationRead productsRead and change productsRead reviewsRead and change reviewsStay connected with a refresh token
Connect Bookingmood in WEXTL
- Log in to your WEXTL account, add the Bookingmood node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Bookingmood account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Bookingmood triggers and actions on WEXTL
The list below is a reference of every Bookingmood node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Bookingmood node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch Events
TriggerInstant change events from Bookingmood.
| Field | Type |
|---|---|
| Event ID | text |
| Event Type | text |
| Date | date |
| New Row | text |
| Old Row | text |
Check Availability
SearchCalendar status of selected units.
| Field | Type |
|---|---|
UnitsRequired | choice |
| Sync External Calendars | boolean |
| Show Booked As | choice |
| Show Closed As | choice |
| Show Pending As | choice |
| Field | Type |
|---|---|
| Unit ID | text |
| Intervals | array |
Get a Booking
SearchReservation details and currency.
| Field | Type |
|---|---|
BookingRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Widget ID | text |
| Currency | text |
| Display Currency | text |
| Exchange Rate | number |
| Silent | boolean |
7other output fields
Get a Booking Detail
SearchSingle note recorded on a reservation.
| Field | Type |
|---|---|
Booking Detail IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Service ID | text |
| Created At | date |
| Updated At | date |
| Value | text |
| Booking ID | text |
| Name | text |
| Option ID | text |
3other output fields
Get a Calendar Event
SearchEntry on the schedule of a unit.
| Field | Type |
|---|---|
Calendar EventRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Notes | text |
| Created At | date |
| Updated At | date |
| Calendar ID | text |
| Type | text |
| Uid | text |
14other output fields
Get a Calendar Event Note
SearchStaff remark with its author.
| Field | Type |
|---|---|
Calendar Event Note IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Author ID | text |
| Note | text |
| Created At | date |
| Updated At | date |
Get a Capacity
SearchGroup size limits for one unit.
| Field | Type |
|---|---|
Capacity IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Product ID | text |
| Capacity Group ID | text |
| Min | number |
| Max | number |
Get a Capacity Group
SearchGuest category profile and wording.
| Field | Type |
|---|---|
Capacity GroupRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Description | text |
| Order | number |
| Type | text |
2other output fields
Get a Contact
SearchGuest contact card with email and phone.
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Avatar | text |
| text | |
| Phone | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Language | text |
21other output fields
Get a Coupon
SearchDiscount code with its wording.
| Field | Type |
|---|---|
CouponRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Code | text |
| Description | text |
| Quota | number |
| Definition | text |
3other output fields
Get a Line Item
SearchSingle priced row of a booking.
| Field | Type |
|---|---|
Line Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Amount | number |
| Quantity | number |
| Created At | date |
| Updated At | date |
| Item Type | text |
| Fee Type | text |
6other output fields
Get a Message
SearchDelivery state of a sent email.
| Field | Type |
|---|---|
Message IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Html | text |
| Attachments | text |
| Status | text |
| Send At | date |
| Subject | text |
| Body | text |
8other output fields
Get a Message Template
SearchTemplate wording and timing rule.
| Field | Type |
|---|---|
Message Template IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Trigger | text |
| Created At | date |
| Updated At | date |
| Subject | text |
| Body | text |
| Attachments | text |
10other output fields
Get a Payment
SearchPayment amount and settlement status.
| Field | Type |
|---|---|
Payment IDRequired | text |
| Field | Type |
|---|---|
| Amount | number |
| Currency | text |
| Paid | number |
| Created At | date |
| Updated At | date |
| ID | text |
| Booking ID | text |
| Due At | date |
8other output fields
Get a Price Calendar Entry
SearchSeasonal rate rule with its limits.
| Field | Type |
|---|---|
Price Calendar Entry IDRequired | text |
| Field | Type |
|---|---|
| Min Duration | number |
| Max Duration | number |
| Created At | date |
| Updated At | date |
| Color | text |
| Min Advance | number |
| Max Advance | number |
| ID | text |
7other output fields
Get a Refund
SearchRefund record tied to an invoice.
| Field | Type |
|---|---|
Refund IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Invoice ID | text |
| Created At | date |
| Updated At | date |
| Due At | date |
| Amount | number |
| Comment | text |
5other output fields
Get a Review
SearchGuest feedback with its author.
| Field | Type |
|---|---|
Review IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Created At | date |
| Updated At | date |
| Author Name | text |
| Author Avatar | text |
| Content | text |
| Rating | number |
5other output fields
Get a Season
SearchNamed pricing period details.
| Field | Type |
|---|---|
Season IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Value | text |
Get a Service
SearchBookable extra with its label.
| Field | Type |
|---|---|
ServiceRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Type | text |
| Order | number |
| Label | text |
| Description | text |
| Parent ID | text |
5other output fields
Get a Task
SearchFollow-up item and completion time.
| Field | Type |
|---|---|
Task IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Created At | date |
| Completed At | date |
| Task Template ID | text |
| Label | text |
| Due At | date |
| Schedule | text |
2other output fields
Get a Task Template
SearchChore blueprint with its timing.
| Field | Type |
|---|---|
Task Template IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Created At | date |
| Updated At | date |
| Moment | text |
| Label | text |
| Status | text |
| Time | text |
Get a Tax
SearchRate and name of a tax.
| Field | Type |
|---|---|
TaxRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Percentage | number |
| Created At | date |
| Updated At | date |
| Label | text |
| Type | text |
Get a Unit
SearchRentable unit profile and timezone.
| Field | Type |
|---|---|
UnitRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Ical Export Secret | text |
| Organization ID | text |
| Timezone | text |
| Images | text |
| Approximate Address | text |
24other output fields
Get a Widget
SearchEmbeddable form title and kind.
| Field | Type |
|---|---|
Widget IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Title | text |
| Type | text |
| Organization ID | text |
| Language | text |
| Visible Months | array |
20other output fields
Get an Attribute
SearchAttribute details for a unit trait.
| Field | Type |
|---|---|
AttributeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Order | number |
| Name | text |
| Type | text |
| Organization ID | text |
Get an Attribute Option
SearchSingle choice value within an attribute.
| Field | Type |
|---|---|
Attribute OptionRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Attribute ID | text |
| Order | number |
| Name | text |
Get an External Calendar
SearchSync status of an imported feed.
| Field | Type |
|---|---|
External Calendar IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Name | text |
| Ical Url | text |
| Last Synced | date |
| Created At | date |
| Updated At | date |
| Sync Requested At | date |
11other output fields
Get an Invoice
SearchInvoice header with its booking.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Organization ID | text |
| Reference | text |
| Booking ID | text |
| Updated At | date |
| Attachment | text |
Get an Organization
SearchAccount plan and profile.
| Field | Type |
|---|---|
| Organization | choice |
| Field | Type |
|---|---|
| Created At | date |
| Updated At | date |
| ID | text |
| Avatar | text |
| Expires At | date |
| Paddle Subscription ID | text |
| Pricing Version | text |
| Deleted At | date |
55other output fields
List Activity
SearchChange history of your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Booking | choice |
| Calendar Event | choice |
| Table Name | text |
| Operation | text |
| Created From | date |
| Created To | date |
| Columns | text |
2other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Txid | number |
| Organization ID | text |
| Booking ID | text |
| Calendar Event ID | text |
| Table Name | text |
| Row ID | text |
8other output fields
List Attribute Options
SearchChoice values across attributes.
| Field | Type |
|---|---|
LimitRequired | number |
| Attribute | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Attribute ID | text |
| Order | number |
| Name | text |
List Attributes
SearchTraits defined for your units.
| Field | Type |
|---|---|
LimitRequired | number |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Order | number |
| Name | text |
| Type | text |
| Organization ID | text |
List Booking Contacts
SearchWhich guest belongs to which booking.
| Field | Type |
|---|---|
LimitRequired | number |
| Contact | choice |
| Booking | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| Contact ID | text |
| Booking ID | text |
| Created At | date |
| ID | text |
List Booking Details
SearchExtra info across bookings.
| Field | Type |
|---|---|
LimitRequired | number |
| Booking | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Service ID | text |
| Created At | date |
| Updated At | date |
| Value | text |
| Booking ID | text |
| Name | text |
| Option ID | text |
3other output fields
List Bookings
SearchReservations in your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Reference | text |
| Method | choice |
| Created From | date |
| Created To | date |
| Confirmed | choice |
| Columns | text |
| Order By | text |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Widget ID | text |
| Currency | text |
| Display Currency | text |
| Exchange Rate | number |
| Silent | boolean |
7other output fields
List Calendar Event Notes
SearchRemarks across calendar events.
| Field | Type |
|---|---|
LimitRequired | number |
| Calendar Event | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Author ID | text |
| Note | text |
| Created At | date |
| Updated At | date |
List Calendar Events
SearchEvents across your unit calendars.
| Field | Type |
|---|---|
LimitRequired | number |
| Type | choice |
| Status | choice |
| Unit | choice |
| Booking | choice |
| Starts From | date |
| Starts To | date |
| Ends From | date |
4other input fields
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Notes | text |
| Created At | date |
| Updated At | date |
| Calendar ID | text |
| Type | text |
| Uid | text |
14other output fields
List Capacities
SearchGroup size limits per unit.
| Field | Type |
|---|---|
LimitRequired | number |
| Unit | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Product ID | text |
| Capacity Group ID | text |
| Min | number |
| Max | number |
List Capacity Groups
SearchGuest categories in use.
| Field | Type |
|---|---|
LimitRequired | number |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Description | text |
| Order | number |
| Type | text |
2other output fields
List Contacts
SearchGuest records matching filters.
| Field | Type |
|---|---|
LimitRequired | number |
| text | |
| Name | text |
| Created From | date |
| Created To | date |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Avatar | text |
| text | |
| Phone | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Language | text |
21other output fields
List Coupon Uses
SearchRedemptions of discount codes.
| Field | Type |
|---|---|
LimitRequired | number |
| Coupon | choice |
| Booking | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Coupon ID | text |
| Booking ID | text |
List Coupons
SearchDiscount codes in your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Code | text |
| Scope | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Code | text |
| Description | text |
| Quota | number |
| Definition | text |
3other output fields
List External Calendars
SearchImported calendar feeds for units.
| Field | Type |
|---|---|
LimitRequired | number |
| Unit | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Name | text |
| Ical Url | text |
| Last Synced | date |
| Created At | date |
| Updated At | date |
| Sync Requested At | date |
11other output fields
List Invoices
SearchBilling documents issued so far.
| Field | Type |
|---|---|
LimitRequired | number |
| Booking | choice |
| Reference | text |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Organization ID | text |
| Reference | text |
| Booking ID | text |
| Updated At | date |
| Attachment | text |
List Line Item Taxes
SearchTaxes charged per line item.
| Field | Type |
|---|---|
LimitRequired | number |
| Line Item ID | text |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Line Item ID | text |
| Tax ID | text |
| Amount | number |
| Percentage | number |
| Type | text |
| Label | text |
List Line Items
SearchCharges on bookings and invoices.
| Field | Type |
|---|---|
LimitRequired | number |
| Booking | choice |
| Invoice | choice |
| Item Type | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Amount | number |
| Quantity | number |
| Created At | date |
| Updated At | date |
| Item Type | text |
| Fee Type | text |
6other output fields
List Members
SearchTeam access list with roles.
| Field | Type |
|---|---|
LimitRequired | number |
| Role | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| User ID | text |
| Created At | date |
| Updated At | date |
| Role | text |
List Message Events
SearchDelivery log for sent emails.
| Field | Type |
|---|---|
LimitRequired | number |
| Message ID | text |
| Event Type | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Message ID | text |
| Created At | date |
| Event Type | text |
| Recipient | text |
| Provider Event ID | text |
| Reason | text |
List Message Templates
SearchMessage templates available in your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Type | choice |
| Status | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Trigger | text |
| Created At | date |
| Updated At | date |
| Subject | text |
| Body | text |
| Attachments | text |
10other output fields
List Messages
SearchEmails sent to guests.
| Field | Type |
|---|---|
LimitRequired | number |
| Booking | choice |
| Status | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Html | text |
| Attachments | text |
| Status | text |
| Send At | date |
| Subject | text |
| Body | text |
8other output fields
List Payments
SearchPayments received so far.
| Field | Type |
|---|---|
LimitRequired | number |
| Booking | choice |
| Invoice | choice |
| Status | choice |
| Due From | date |
| Due To | date |
| Columns | text |
| Order By | text |
1other input field
| Field | Type |
|---|---|
| Amount | number |
| Currency | text |
| Paid | number |
| Created At | date |
| Updated At | date |
| ID | text |
| Booking ID | text |
| Due At | date |
8other output fields
List Price Calendar Entries
SearchPrice rules defined per unit.
| Field | Type |
|---|---|
LimitRequired | number |
| Unit | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| Min Duration | number |
| Max Duration | number |
| Created At | date |
| Updated At | date |
| Color | text |
| Min Advance | number |
| Max Advance | number |
| ID | text |
7other output fields
List Refunds
SearchRefunds issued to guests.
| Field | Type |
|---|---|
LimitRequired | number |
| Booking | choice |
| Status | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Invoice ID | text |
| Created At | date |
| Updated At | date |
| Due At | date |
| Amount | number |
| Comment | text |
5other output fields
List Reviews
SearchGuest feedback entries on file.
| Field | Type |
|---|---|
LimitRequired | number |
| Status | choice |
| Booking | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Created At | date |
| Updated At | date |
| Author Name | text |
| Author Avatar | text |
| Content | text |
| Rating | number |
5other output fields
List Seasons
SearchPricing periods you defined.
| Field | Type |
|---|---|
LimitRequired | number |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Value | text |
List Services
SearchBookable extras for guests.
| Field | Type |
|---|---|
LimitRequired | number |
| Type | choice |
| Parent Service | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Type | text |
| Order | number |
| Label | text |
| Description | text |
| Parent ID | text |
5other output fields
List Sites
SearchBooking sites you host.
| Field | Type |
|---|---|
LimitRequired | number |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Autocomplete Date Selection | boolean |
| Color Background | text |
| Color Error | text |
| Color Primary | text |
| Color Text | text |
44other output fields
List Task Templates
SearchAutomatic chore blueprints for units.
| Field | Type |
|---|---|
LimitRequired | number |
| Unit | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Created At | date |
| Updated At | date |
| Moment | text |
| Label | text |
| Status | text |
| Time | text |
List Tasks
SearchFollow-up items across events.
| Field | Type |
|---|---|
LimitRequired | number |
| Calendar Event | choice |
| Completed | choice |
| Due From | date |
| Due To | date |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Created At | date |
| Completed At | date |
| Task Template ID | text |
| Label | text |
| Due At | date |
| Schedule | text |
2other output fields
List Taxes
SearchTax rates you defined.
| Field | Type |
|---|---|
LimitRequired | number |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Percentage | number |
| Created At | date |
| Updated At | date |
| Label | text |
| Type | text |
List Units
SearchRentable units in your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Name | text |
| Interaction | choice |
| Include Deleted | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Ical Export Secret | text |
| Organization ID | text |
| Timezone | text |
| Images | text |
| Approximate Address | text |
24other output fields
List Widgets
SearchBooking forms in your account.
| Field | Type |
|---|---|
LimitRequired | number |
| Type | choice |
| Columns | text |
| Order By | text |
| Extra Filters | array |
| Filter | object |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Title | text |
| Type | text |
| Organization ID | text |
| Language | text |
| Visible Months | array |
20other output fields
Search Units
SearchMatching units for a stay.
| Field | Type |
|---|---|
| Start Date | date |
| End Date | date |
| Occupancy | array |
| Group | object |
| Attribute Options | choice |
| Units | choice |
| Show Booked As | choice |
| Show Closed As | choice |
| Show Pending As | choice |
| Field | Type |
|---|---|
| Unit ID | text |
| Match | boolean |
| Availability | text |
| Occupancy Matches | boolean |
| Options Match | boolean |
| Price | object |
| Min | number |
| Max | number |
Add a Contact to a Booking
ActionTies a guest record to a reservation.
| Field | Type |
|---|---|
ContactRequired | choice |
BookingRequired | choice |
| Field | Type |
|---|---|
| Contact ID | text |
| Booking ID | text |
| Created At | date |
| ID | text |
Book a Unit
ActionReservation for one unit with a payment link.
| Field | Type |
|---|---|
UnitRequired | choice |
Start DateRequired | date |
End DateRequired | date |
OccupancyRequired | array |
| Group | object |
| Form Values | array |
| Form value | object |
| Coupon Codes | array |
| Coupon code | text |
| Currency | choice |
| Language | choice |
3other input fields
| Field | Type |
|---|---|
| Booking ID | text |
| Payment Expiry Timestamp | number |
| Payment URL | text |
| Reference | text |
| Secret | text |
Check Out a Cart
ActionBooks several units in a single order.
| Field | Type |
|---|---|
ItemsRequired | array |
| Item | object |
| Coupon Codes | array |
| Coupon code | text |
| Currency | choice |
| Language | choice |
| Show Pending As | choice |
| Redirect URL | text |
| Failure URL | text |
| Field | Type |
|---|---|
| Booking ID | text |
| Payment Expiry Timestamp | number |
| Payment URL | text |
| Reference | text |
| Secret | text |
Create a Booking Detail
ActionExtra note stored on a reservation.
| Field | Type |
|---|---|
BookingRequired | choice |
NameRequired | text |
DescriptionRequired | text |
| Value | text |
| Service | choice |
| Option | choice |
| Calendar Event | choice |
| Language | choice |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Service ID | text |
| Created At | date |
| Updated At | date |
| Value | text |
| Booking ID | text |
| Name | text |
| Option ID | text |
3other output fields
Create a Calendar Event Note
ActionRemark attached to a calendar event.
| Field | Type |
|---|---|
Calendar EventRequired | choice |
NoteRequired | text |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Author ID | text |
| Note | text |
| Created At | date |
| Updated At | date |
Create a Capacity
ActionGuest count limits for a unit.
| Field | Type |
|---|---|
UnitRequired | choice |
Capacity GroupRequired | choice |
| Minimum | number |
| Maximum | number |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Product ID | text |
| Capacity Group ID | text |
| Min | number |
| Max | number |
Create a Capacity Group
ActionGuest category used for occupancy.
| Field | Type |
|---|---|
NameRequired | text |
DescriptionRequired | text |
Singular NameRequired | text |
| Type | choice |
| Order | number |
| Requires Explicit Input | boolean |
| Language | choice |
| Organization | choice |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Description | text |
| Order | number |
| Type | text |
2other output fields
Create a Contact
ActionGuest record with contact details.
| Field | Type |
|---|---|
| text | |
| First Name | text |
| Last Name | text |
| Phone | text |
| Company Name | text |
| Street | text |
| Street 2 | text |
| Postal Code | text |
11other input fields
| Field | Type |
|---|---|
| ID | text |
| Avatar | text |
| text | |
| Phone | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Language | text |
21other output fields
Create a Coupon
ActionDiscount code for reservations.
| Field | Type |
|---|---|
CodeRequired | text |
DefinitionRequired | text |
| Description | text |
| Quota | number |
| Scope | choice |
| Stackable | boolean |
| Organization | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Code | text |
| Description | text |
| Quota | number |
| Definition | text |
3other output fields
Create a Coupon Use
ActionLogs one discount redemption.
| Field | Type |
|---|---|
CouponRequired | choice |
BookingRequired | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Coupon ID | text |
| Booking ID | text |
Create a Line Item
ActionCharge row on a booking.
| Field | Type |
|---|---|
BookingRequired | choice |
NameRequired | text |
AmountRequired | number |
QuantityRequired | number |
| Item Type | choice |
| Fee Type | choice |
| Invoice | choice |
| Service | choice |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Amount | number |
| Quantity | number |
| Created At | date |
| Updated At | date |
| Item Type | text |
| Fee Type | text |
6other output fields
Create a Line Item Tax
ActionTax portion of a charge.
| Field | Type |
|---|---|
Line Item IDRequired | text |
LabelRequired | text |
AmountRequired | number |
PercentageRequired | number |
| Tax | choice |
| Type | choice |
| Language | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Line Item ID | text |
| Tax ID | text |
| Amount | number |
| Percentage | number |
| Type | text |
| Label | text |
Create a Message Template
ActionReusable message for guests.
| Field | Type |
|---|---|
SubjectRequired | text |
BodyRequired | text |
AttachmentsRequired | text |
| Trigger | choice |
| Type | choice |
| Status | choice |
| Moment | text |
| Time | text |
8other input fields
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Trigger | text |
| Created At | date |
| Updated At | date |
| Subject | text |
| Body | text |
| Attachments | text |
10other output fields
Create a Payment
ActionMoney received for a reservation.
| Field | Type |
|---|---|
BookingRequired | choice |
InvoiceRequired | choice |
CurrencyRequired | choice |
AmountRequired | number |
Due AtRequired | date |
| Reference | text |
| Offline | boolean |
| Completed At | date |
1other input field
| Field | Type |
|---|---|
| Amount | number |
| Currency | text |
| Paid | number |
| Created At | date |
| Updated At | date |
| ID | text |
| Booking ID | text |
| Due At | date |
8other output fields
Create a Price Calendar Entry
ActionSeasonal pricing rule for a unit.
| Field | Type |
|---|---|
UnitRequired | choice |
NameRequired | text |
Check-In DaysRequired | choice |
Check-Out DaysRequired | choice |
RatesRequired | text |
| Date Ranges | array |
| Date Range | object |
| Minimum Duration | number |
| Maximum Duration | number |
6other input fields
| Field | Type |
|---|---|
| Min Duration | number |
| Max Duration | number |
| Created At | date |
| Updated At | date |
| Color | text |
| Min Advance | number |
| Max Advance | number |
| ID | text |
7other output fields
Create a Refund
ActionMoney returned to a guest.
| Field | Type |
|---|---|
BookingRequired | choice |
InvoiceRequired | choice |
AmountRequired | number |
CurrencyRequired | choice |
Due AtRequired | date |
ReferenceRequired | text |
StatusRequired | choice |
| Comment | text |
2other input fields
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Invoice ID | text |
| Created At | date |
| Updated At | date |
| Due At | date |
| Amount | number |
| Comment | text |
5other output fields
Create a Review
ActionGuest feedback entry for a stay.
| Field | Type |
|---|---|
ContentRequired | text |
SourceRequired | text |
| Author Name | text |
| Rating | number |
| Status | choice |
| Source URL | text |
| Booking | choice |
| Language | choice |
2other input fields
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Created At | date |
| Updated At | date |
| Author Name | text |
| Author Avatar | text |
| Content | text |
| Rating | number |
5other output fields
Create a Season
ActionNamed period for pricing rules.
| Field | Type |
|---|---|
NameRequired | text |
ValueRequired | text |
| Language | choice |
| Organization | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Value | text |
Create a Service
ActionBookable extra or form field.
| Field | Type |
|---|---|
TypeRequired | choice |
LabelRequired | text |
DescriptionRequired | text |
MetadataRequired | text |
| Parent Service | choice |
| Order | number |
| Fee | text |
| Deposit | text |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Type | text |
| Order | number |
| Label | text |
| Description | text |
| Parent ID | text |
5other output fields
Create a Task
ActionFollow-up item on an event.
| Field | Type |
|---|---|
Calendar EventRequired | choice |
LabelRequired | text |
| Due At | date |
| Schedule | choice |
| Completed At | date |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Created At | date |
| Completed At | date |
| Task Template ID | text |
| Label | text |
| Due At | date |
| Schedule | text |
2other output fields
Create a Task Template
ActionRecurring task blueprint for a unit.
| Field | Type |
|---|---|
UnitRequired | choice |
MomentRequired | text |
| Label | text |
| Status | choice |
| Time | text |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Created At | date |
| Updated At | date |
| Moment | text |
| Label | text |
| Status | text |
| Time | text |
Create a Tax
ActionRate that can be applied to charges.
| Field | Type |
|---|---|
LabelRequired | text |
PercentageRequired | number |
| Type | choice |
| Language | choice |
| Organization | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Percentage | number |
| Created At | date |
| Updated At | date |
| Label | text |
| Type | text |
Create a Unit
ActionRentable property or room.
| Field | Type |
|---|---|
NameRequired | text |
CurrencyRequired | choice |
Payment Expiration (Seconds)Required | number |
| Description | text |
| Timezone | text |
| Rent Period | choice |
| Interaction | choice |
| Confirmation Message | text |
7other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Ical Export Secret | text |
| Organization ID | text |
| Timezone | text |
| Images | text |
| Approximate Address | text |
24other output fields
Create a Widget
ActionEmbeddable booking form for sites.
| Field | Type |
|---|---|
SettingsRequired | text |
| Title | text |
| Type | choice |
| Language | choice |
| Currency | choice |
| Redirect URL | text |
| Interaction | choice |
| Show Bookingmood Branding | boolean |
9other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Title | text |
| Type | text |
| Organization ID | text |
| Language | text |
| Visible Months | array |
20other output fields
Create an Attribute
ActionSearchable trait for your units.
| Field | Type |
|---|---|
NameRequired | text |
TypeRequired | choice |
| Order | number |
| Language | choice |
| Organization | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Order | number |
| Name | text |
| Type | text |
| Organization ID | text |
Create an Attribute Option
ActionChoice value inside an attribute.
| Field | Type |
|---|---|
AttributeRequired | choice |
NameRequired | text |
| Order | number |
| Language | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Attribute ID | text |
| Order | number |
| Name | text |
Create an External Calendar
ActionImported iCal feed for a unit.
| Field | Type |
|---|---|
UnitRequired | choice |
iCal URLRequired | text |
| Name | text |
| Time Offset (Hours) | number |
| Event Status | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Name | text |
| Ical Url | text |
| Last Synced | date |
| Created At | date |
| Updated At | date |
| Sync Requested At | date |
11other output fields
Create an Invoice
ActionBilling document for a booking.
| Field | Type |
|---|---|
BookingRequired | choice |
ReferenceRequired | text |
| Attachment | text |
| Organization | choice |
| Additional Fields | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Organization ID | text |
| Reference | text |
| Booking ID | text |
| Updated At | date |
| Attachment | text |
Delete a Booking
ActionReservation deleted from the account.
| Field | Type |
|---|---|
BookingRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Widget ID | text |
| Currency | text |
| Display Currency | text |
| Exchange Rate | number |
| Silent | boolean |
7other output fields
Delete a Booking Detail
ActionDetail removed from a reservation.
| Field | Type |
|---|---|
Booking Detail IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Service ID | text |
| Created At | date |
| Updated At | date |
| Value | text |
| Booking ID | text |
| Name | text |
| Option ID | text |
3other output fields
Delete a Calendar Event
ActionEvent deleted from a unit calendar.
| Field | Type |
|---|---|
Calendar EventRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Notes | text |
| Created At | date |
| Updated At | date |
| Calendar ID | text |
| Type | text |
| Uid | text |
14other output fields
Delete a Calendar Event Note
ActionA note taken off a calendar entry.
| Field | Type |
|---|---|
Calendar Event Note IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Author ID | text |
| Note | text |
| Created At | date |
| Updated At | date |
Delete a Capacity
ActionGuest limits cleared for a unit.
| Field | Type |
|---|---|
Capacity IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Product ID | text |
| Capacity Group ID | text |
| Min | number |
| Max | number |
Delete a Capacity Group
ActionGuest category dropped from occupancy.
| Field | Type |
|---|---|
Capacity GroupRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Description | text |
| Order | number |
| Type | text |
2other output fields
Delete a Contact
ActionGuest record removed from contacts.
| Field | Type |
|---|---|
ContactRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Avatar | text |
| text | |
| Phone | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Language | text |
21other output fields
Delete a Coupon
ActionDiscount code removed from guests.
| Field | Type |
|---|---|
CouponRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Code | text |
| Description | text |
| Quota | number |
| Definition | text |
3other output fields
Delete a Coupon Use
ActionCoupon redemption removed from a booking.
| Field | Type |
|---|---|
Coupon Use IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Coupon ID | text |
| Booking ID | text |
Delete a Line Item
ActionCharge row cleared from a booking.
| Field | Type |
|---|---|
Line Item IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Amount | number |
| Quantity | number |
| Created At | date |
| Updated At | date |
| Item Type | text |
| Fee Type | text |
6other output fields
Delete a Line Item Tax
ActionTax portion cleared from a charge.
| Field | Type |
|---|---|
Line Item Tax IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Line Item ID | text |
| Tax ID | text |
| Amount | number |
| Percentage | number |
| Type | text |
| Label | text |
Delete a Message Template
ActionMessage template deleted from your account.
| Field | Type |
|---|---|
Message Template IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Trigger | text |
| Created At | date |
| Updated At | date |
| Subject | text |
| Body | text |
| Attachments | text |
10other output fields
Delete a Payment
ActionPayment removed from a booking.
| Field | Type |
|---|---|
Payment IDRequired | text |
| Field | Type |
|---|---|
| Amount | number |
| Currency | text |
| Paid | number |
| Created At | date |
| Updated At | date |
| ID | text |
| Booking ID | text |
| Due At | date |
8other output fields
Delete a Price Calendar Entry
ActionPricing rule cleared for a unit.
| Field | Type |
|---|---|
Price Calendar Entry IDRequired | text |
| Field | Type |
|---|---|
| Min Duration | number |
| Max Duration | number |
| Created At | date |
| Updated At | date |
| Color | text |
| Min Advance | number |
| Max Advance | number |
| ID | text |
7other output fields
Delete a Refund
ActionRefund record taken off a booking.
| Field | Type |
|---|---|
Refund IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Invoice ID | text |
| Created At | date |
| Updated At | date |
| Due At | date |
| Amount | number |
| Comment | text |
5other output fields
Delete a Review
ActionGuest review removed from your account.
| Field | Type |
|---|---|
Review IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Created At | date |
| Updated At | date |
| Author Name | text |
| Author Avatar | text |
| Content | text |
| Rating | number |
5other output fields
Delete a Season
ActionSeason removed from your pricing.
| Field | Type |
|---|---|
Season IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Value | text |
Delete a Service
ActionExtra service deleted from your account.
| Field | Type |
|---|---|
ServiceRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Type | text |
| Order | number |
| Label | text |
| Description | text |
| Parent ID | text |
5other output fields
Delete a Task
ActionFollow-up item cleared from an event.
| Field | Type |
|---|---|
Task IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Created At | date |
| Completed At | date |
| Task Template ID | text |
| Label | text |
| Due At | date |
| Schedule | text |
2other output fields
Delete a Task Template
ActionTask template removed from a unit.
| Field | Type |
|---|---|
Task Template IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Created At | date |
| Updated At | date |
| Moment | text |
| Label | text |
| Status | text |
| Time | text |
Delete a Tax
ActionTax rate removed from your account.
| Field | Type |
|---|---|
TaxRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Percentage | number |
| Created At | date |
| Updated At | date |
| Label | text |
| Type | text |
Delete a Unit
ActionRentable unit deleted from your account.
| Field | Type |
|---|---|
UnitRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Ical Export Secret | text |
| Organization ID | text |
| Timezone | text |
| Images | text |
| Approximate Address | text |
24other output fields
Delete a Widget
ActionBooking widget deleted from your site.
| Field | Type |
|---|---|
Widget IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Title | text |
| Type | text |
| Organization ID | text |
| Language | text |
| Visible Months | array |
20other output fields
Delete an Attribute
ActionUnit attribute deleted from the account.
| Field | Type |
|---|---|
AttributeRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Order | number |
| Name | text |
| Type | text |
| Organization ID | text |
Delete an Attribute Option
ActionOption removed from an attribute list.
| Field | Type |
|---|---|
Attribute OptionRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Attribute ID | text |
| Order | number |
| Name | text |
Delete an External Calendar
ActioniCal feed unlinked from a unit.
| Field | Type |
|---|---|
External Calendar IDRequired | text |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Name | text |
| Ical Url | text |
| Last Synced | date |
| Created At | date |
| Updated At | date |
| Sync Requested At | date |
11other output fields
Delete an Invoice
ActionInvoice taken off a booking.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Organization ID | text |
| Reference | text |
| Booking ID | text |
| Updated At | date |
| Attachment | text |
Invite a Member
ActionTeammate invitation by email.
| Field | Type |
|---|---|
EmailRequired | text |
| Name | text |
| Language | choice |
| Organization | choice |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| User ID | text |
| Created At | date |
| Updated At | date |
| Role | text |
Make an API Call
universalYour own Bookingmood REST API request.
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
| Headers | array |
| Header | object |
| Query string | array |
| Parameter | object |
| Body | text |
Remove a Contact from a Booking
ActionGuest taken off a reservation.
| Field | Type |
|---|---|
ContactRequired | choice |
BookingRequired | choice |
| Field | Type |
|---|---|
| Contact ID | text |
| Booking ID | text |
| Created At | date |
| ID | text |
Remove a Member
ActionTeam access revoked for one person.
| Field | Type |
|---|---|
MemberRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| User ID | text |
| Created At | date |
| Updated At | date |
| Role | text |
Update a Booking
ActionAdjusts the details of a reservation.
| Field | Type |
|---|---|
BookingRequired | choice |
| Reference | text |
| Currency | choice |
| Display Currency | choice |
| Silent | choice |
| Confirmed At | date |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Widget ID | text |
| Currency | text |
| Display Currency | text |
| Exchange Rate | number |
| Silent | boolean |
7other output fields
Update a Booking Detail
ActionCorrects info stored on a booking.
| Field | Type |
|---|---|
Booking Detail IDRequired | text |
| Name | text |
| Description | text |
| Value | text |
| Language | choice |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Service ID | text |
| Created At | date |
| Updated At | date |
| Value | text |
| Booking ID | text |
| Name | text |
| Option ID | text |
3other output fields
Update a Calendar Event
ActionMoves or retitles a calendar slot.
| Field | Type |
|---|---|
Calendar EventRequired | choice |
| Status | choice |
| Title | text |
| Notes | text |
| Start Date | date |
| End Date | date |
| Padding | number |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Notes | text |
| Created At | date |
| Updated At | date |
| Calendar ID | text |
| Type | text |
| Uid | text |
14other output fields
Update a Calendar Event Note
ActionEdits a staff remark on an event.
| Field | Type |
|---|---|
Calendar Event Note IDRequired | text |
| Note | text |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Author ID | text |
| Note | text |
| Created At | date |
| Updated At | date |
Update a Capacity
ActionRetunes group size limits for a unit.
| Field | Type |
|---|---|
Capacity IDRequired | text |
| Minimum | number |
| Maximum | number |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Product ID | text |
| Capacity Group ID | text |
| Min | number |
| Max | number |
Update a Capacity Group
ActionReshapes a guest category.
| Field | Type |
|---|---|
Capacity GroupRequired | choice |
| Name | text |
| Description | text |
| Singular Name | text |
| Type | choice |
| Order | number |
| Requires Explicit Input | choice |
| Language | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Description | text |
| Order | number |
| Type | text |
2other output fields
Update a Contact
ActionFixes a guest record.
| Field | Type |
|---|---|
ContactRequired | choice |
| text | |
| First Name | text |
| Last Name | text |
| Phone | text |
| Company Name | text |
| Street | text |
| Street 2 | text |
11other input fields
| Field | Type |
|---|---|
| ID | text |
| Avatar | text |
| text | |
| Phone | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Language | text |
21other output fields
Update a Coupon
ActionReworks a discount code.
| Field | Type |
|---|---|
CouponRequired | choice |
| Code | text |
| Definition | text |
| Description | text |
| Quota | number |
| Scope | choice |
| Stackable | choice |
| Deleted At | date |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Code | text |
| Description | text |
| Quota | number |
| Definition | text |
3other output fields
Update a Line Item
ActionCorrects a priced row on a booking.
| Field | Type |
|---|---|
Line Item IDRequired | text |
| Name | text |
| Amount | number |
| Quantity | number |
| Item Type | choice |
| Fee Type | choice |
| Invoice | choice |
| Service | choice |
3other input fields
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Amount | number |
| Quantity | number |
| Created At | date |
| Updated At | date |
| Item Type | text |
| Fee Type | text |
6other output fields
Update a Message Template
ActionRetunes a guest message.
| Field | Type |
|---|---|
Message Template IDRequired | text |
| Subject | text |
| Body | text |
| Attachments | text |
| Trigger | choice |
| Type | choice |
| Status | choice |
| Moment | text |
8other input fields
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Trigger | text |
| Created At | date |
| Updated At | date |
| Subject | text |
| Body | text |
| Attachments | text |
10other output fields
Update a Payment
ActionCorrects the figures of a payment.
| Field | Type |
|---|---|
Payment IDRequired | text |
| Currency | choice |
| Amount | number |
| Due At | date |
| Reference | text |
| Offline | choice |
| Completed At | date |
| Clear Fields | choice |
| Field | Type |
|---|---|
| Amount | number |
| Currency | text |
| Paid | number |
| Created At | date |
| Updated At | date |
| ID | text |
| Booking ID | text |
| Due At | date |
8other output fields
Update a Price Calendar Entry
ActionReprices a unit for stays.
| Field | Type |
|---|---|
Price Calendar Entry IDRequired | text |
| Name | text |
| Check-In Days | choice |
| Check-Out Days | choice |
| Rates | text |
| Date Ranges | array |
| Date Range | object |
| Minimum Duration | number |
| Maximum Duration | number |
5other input fields
| Field | Type |
|---|---|
| Min Duration | number |
| Max Duration | number |
| Created At | date |
| Updated At | date |
| Color | text |
| Min Advance | number |
| Max Advance | number |
| ID | text |
7other output fields
Update a Refund
ActionFixes the figures on a refund.
| Field | Type |
|---|---|
Refund IDRequired | text |
| Amount | number |
| Currency | choice |
| Due At | date |
| Reference | text |
| Status | choice |
| Comment | text |
| Policy | text |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Invoice ID | text |
| Created At | date |
| Updated At | date |
| Due At | date |
| Amount | number |
| Comment | text |
5other output fields
Update a Review
ActionModerates guest feedback text.
| Field | Type |
|---|---|
Review IDRequired | text |
| Content | text |
| Source | text |
| Author Name | text |
| Rating | number |
| Status | choice |
| Source URL | text |
| Language | choice |
1other input field
| Field | Type |
|---|---|
| ID | text |
| Booking ID | text |
| Created At | date |
| Updated At | date |
| Author Name | text |
| Author Avatar | text |
| Content | text |
| Rating | number |
5other output fields
Update a Season
ActionRetitles a pricing period.
| Field | Type |
|---|---|
Season IDRequired | text |
| Name | text |
| Value | text |
| Language | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Organization ID | text |
| Name | text |
| Value | text |
Update a Service
ActionReprices a bookable extra.
| Field | Type |
|---|---|
ServiceRequired | choice |
| Label | text |
| Description | text |
| Parent Service | choice |
| Order | number |
| Metadata | text |
| Fee | text |
| Deposit | text |
2other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Type | text |
| Order | number |
| Label | text |
| Description | text |
| Parent ID | text |
5other output fields
Update a Site
ActionReconfigures how a site looks.
| Field | Type |
|---|---|
Site IDRequired | text |
| Name | text |
| Currency | choice |
| Subdomain | text |
| Week Starts On | number |
| First Week Contains Date | number |
| Redirect URL | text |
| Failure URL | text |
6other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Autocomplete Date Selection | boolean |
| Color Background | text |
| Color Error | text |
| Color Primary | text |
| Color Text | text |
44other output fields
Update a Task
ActionReschedules or finishes a to-do.
| Field | Type |
|---|---|
Task IDRequired | text |
| Label | text |
| Due At | date |
| Schedule | choice |
| Completed At | date |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Calendar Event ID | text |
| Created At | date |
| Completed At | date |
| Task Template ID | text |
| Label | text |
| Due At | date |
| Schedule | text |
2other output fields
Update a Task Template
ActionRetimes an automatic chore.
| Field | Type |
|---|---|
Task Template IDRequired | text |
| Moment | text |
| Label | text |
| Status | choice |
| Time | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Created At | date |
| Updated At | date |
| Moment | text |
| Label | text |
| Status | text |
| Time | text |
Update a Tax
ActionRevises a tax rate.
| Field | Type |
|---|---|
TaxRequired | choice |
| Label | text |
| Percentage | number |
| Type | choice |
| Language | choice |
| Field | Type |
|---|---|
| ID | text |
| Organization ID | text |
| Percentage | number |
| Created At | date |
| Updated At | date |
| Label | text |
| Type | text |
Update a Unit
ActionReconfigures a rentable property.
| Field | Type |
|---|---|
UnitRequired | choice |
| Name | text |
| Description | text |
| Currency | choice |
| Payment Expiration (Seconds) | number |
| Timezone | text |
| Rent Period | choice |
| Interaction | choice |
6other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Ical Export Secret | text |
| Organization ID | text |
| Timezone | text |
| Images | text |
| Approximate Address | text |
24other output fields
Update a Widget
ActionRetunes an embeddable booking form.
| Field | Type |
|---|---|
Widget IDRequired | text |
| Settings | text |
| Title | text |
| Type | choice |
| Language | choice |
| Currency | choice |
| Redirect URL | text |
| Interaction | choice |
9other input fields
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Updated At | date |
| Title | text |
| Type | text |
| Organization ID | text |
| Language | text |
| Visible Months | array |
20other output fields
Update an Attribute
ActionRetitles or retypes a unit trait.
| Field | Type |
|---|---|
AttributeRequired | choice |
| Name | text |
| Type | choice |
| Order | number |
| Language | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Order | number |
| Name | text |
| Type | text |
| Organization ID | text |
Update an Attribute Option
ActionReworded choice inside an attribute.
| Field | Type |
|---|---|
Attribute OptionRequired | choice |
| Name | text |
| Order | number |
| Language | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Attribute ID | text |
| Order | number |
| Name | text |
Update an External Calendar
ActionRepoints an imported feed.
| Field | Type |
|---|---|
External Calendar IDRequired | text |
| iCal URL | text |
| Name | text |
| Time Offset (Hours) | number |
| Event Status | choice |
| Field | Type |
|---|---|
| ID | text |
| Product ID | text |
| Name | text |
| Ical Url | text |
| Last Synced | date |
| Created At | date |
| Updated At | date |
| Sync Requested At | date |
11other output fields
Update an Invoice
ActionCorrects billing paperwork details.
| Field | Type |
|---|---|
InvoiceRequired | choice |
| Reference | text |
| Attachment | text |
| Clear Fields | choice |
| Field | Type |
|---|---|
| ID | text |
| Created At | date |
| Organization ID | text |
| Reference | text |
| Booking ID | text |
| Updated At | date |
| Attachment | text |
Validate a Cart
ActionDry run of a cart before payment.
| Field | Type |
|---|---|
ItemsRequired | array |
| Item | object |
| Coupon Codes | array |
| Coupon code | text |
| Show Pending As | choice |
| Field | Type |
|---|---|
| Item ID | text |
| Availability Match | boolean |
| Occupancy Match | boolean |
| Price | object |
| Currency | text |
| Deposit | number |
| Subtotal | number |
| Tax | number |
| Total | number |
| Lines | array |
Templates
Look for Bookingmood templates in the WEXTL template library.
Browse templates →Other scheduling integrations on WEXTL
Anny Admin API[2]Online booking and scheduling platform for managing services, resources, timeslots, and customer appointments.
BoulevardClient experience and booking platform for salons, spas, and appointment-based self-care businesses.
CalendeskOnline booking and appointment scheduling for service businesses.
BookeoOnline booking and appointment scheduling platform for tours, classes, and service businesses.
Cal.comOpen scheduling with event types, bookings, teams, organizations and webhooks.
References
- WEXTL® Bookingmood Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Bookingmood.
- WEXTL® visual workflow builder data.
Last updated: Nov 14, 2026 14:55
How we write our apps documentation
How we compile these docs: sources, the role of AI, and how we verify.





























