Requirements
Before you set up the credential, make sure you have an active Booxi account and an API access token from your account settings ready.[3]
Get your Booxi credentials
- API KeypasswordRequired
- URL RegionselectRequired
Connect Booxi in WEXTL
- Log in to your WEXTL account, add the Booxi node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Booxi 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 →

Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Booxi node modules
The list below is a reference of every Booxi node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Each Booxi node module below opens to reveal its input parameters, outputs, and connection requirements.
Watch BookingsTrigger
| Field | Type |
|---|---|
| Booking ID | text |
| Merchant ID | number |
| Booking method | text |
| Status | text |
| Is completed | boolean |
| Starts on | date |
| Total client timespan | object |
| Start | text |
| End | text |
| Duration | number |
| Staff ID | number |
| Staff first name | text |
| Staff last name | text |
| Items | array |
| Location | text |
| Location text | text |
| Client | object |
| ID | number |
| First name | text |
| Last name | text |
| Home phone number | text |
| Mobile phone number | text |
| Presence | text |
| Remind by email | boolean |
| Remind by sms | boolean |
| Additional request | text |
Watch ClientTrigger
| Field | Type |
|---|---|
| ID | number |
| Membership number | text |
| Merchant ID | number |
| First name | text |
| Last name | text |
| Language | text |
| text | |
| Home phone number | text |
| Mobile phone number | text |
| Remind by sms | boolean |
| Remind by email | boolean |
| In mailing list | boolean |
| Date of birth | object |
| Day | number |
| Month | number |
| Year | number |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
Watch Group EventsTrigger
| Field | Type |
|---|---|
| ID | number |
| Start | text |
| Duration | number |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Location | text |
| Location text | text |
| Staff ID | number |
| Staff name | text |
| Staff first name | text |
| Staff last name | text |
| Staff | object |
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | text |
| Time selection mode | text |
| Service ID | number |
| Service name | text |
| Service category ID | number |
Watch MerchantTrigger
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Contact first name | text |
| Contact last name | text |
| Phone number | text |
| text | |
| Tags | text |
Watch ServicecategoryTrigger
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Description | text |
| Profile image URL | url |
| Merchant ID | number |
| Is template | boolean |
| Service category template ID | number |
Watch ServicesTrigger
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Has price customization | boolean |
| Category ID | number |
| Category name | text |
Watch StaffsTrigger
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
| Communication email | |
| Login email | |
| User role | text |
| Invitation status | text |
Watch TimeslotTrigger
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Owner type | text |
| Staff ID | number |
| Type | text |
| Start | text |
| End | text |
| Can modify | boolean |
| Description | text |
| Availability tags | text |
Get a BookingAction
| Field | Type |
|---|---|
Booking IDRequired | choice |
| Language | choice |
| Field | Type |
|---|---|
| Booking ID | text |
| Merchant ID | number |
| Booking method | text |
| Status | text |
| Is completed | boolean |
| Starts on | date |
| Total client timespan | object |
| Start | text |
| End | text |
| Duration | number |
| Staff ID | number |
| Items | array |
| Location | text |
| Location text | text |
| Client | object |
| ID | number |
| First name | text |
| Last name | text |
| text | |
| Home phone number | text |
| Mobile phone number | text |
| Presence | text |
| Remind by email | boolean |
| Remind by sms | boolean |
| Additional request | text |
| Payment | object |
| Total | text |
| Paid | text |
| Online payment status | text |
| Created on | date |
Get a ClientAction
| Field | Type |
|---|---|
Client IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| First name | text |
| Last name | text |
| text | |
| Home phone number | text |
| Mobile phone number | text |
| Remind by sms | boolean |
| Remind by email | boolean |
| In mailing list | boolean |
| Date of birth | object |
| Day | number |
| Month | number |
| Year | number |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Status | text |
| Quick note | text |
Get a Client Module LinkAction
| Field | Type |
|---|---|
Client IDRequired | choice |
Module IDRequired | text |
| Field | Type |
|---|---|
| Link | object |
| Module ID | text |
| Client ID | number |
| External ID | text |
| Metadata | object |
| Created on | text |
| Modified on | text |
| Client | object |
| ID | number |
| Merchant ID | number |
| First name | text |
| Last name | text |
| Home phone number | text |
| Mobile phone number | text |
| Metadata | object |
Get a Group EventAction
| Field | Type |
|---|---|
Group Event IDRequired | choice |
| Language | choice |
| Field | Type |
|---|---|
| ID | number |
| Start | text |
| Duration | number |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Location | text |
| Location text | text |
| Staff ID | number |
| Staff name | text |
| Staff first name | text |
| Staff last name | text |
| Staff | object |
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
| Service ID | number |
| Service name | text |
| Service category ID | number |
Get a MerchantAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Template merchant ID | number |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Contact first name | text |
| Contact last name | text |
| Phone number | text |
Get a Merchant Module LinkAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
Module IDRequired | text |
| Field | Type |
|---|---|
| Link | object |
| Merchant ID | number |
| Module ID | text |
| External ID | text |
| Metadata | object |
| Created on | text |
| Modified on | text |
| Merchant | object |
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Template merchant ID | number |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
Get a Merchant ScheduleAction
Get a ServiceAction
| Field | Type |
|---|---|
Service IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Has price customization | boolean |
| Category ID | number |
| Category name | text |
Get a Service AvailabilityAction
| Field | Type |
|---|---|
Service IDRequired | choice |
FromRequired | date |
ToRequired | date |
| Staff ID | choice |
| Language | text |
| Field | Type |
|---|---|
| Start | date |
| End | date |
| Service ID | number |
| Staff ID | number |
| Time selection mode | text |
| Duration | number |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Location text | text |
| Group event ID | number |
| Capacity | number |
| Places left | number |
| Metadata | object |
| Classification | text |
Get a Service CategoryAction
Get a Service Category Module LinkAction
| Field | Type |
|---|---|
Service Category IDRequired | choice |
Module IDRequired | text |
| Field | Type |
|---|---|
| Link | object |
| Service category ID | number |
| Module ID | text |
| External ID | text |
| Metadata | object |
| Created on | date |
| Modified on | date |
| Service category | object |
| ID | number |
| Name | text |
| Description | text |
| Profile image URL | url |
| Merchant ID | number |
| Is template | boolean |
| Service category template ID | number |
Get a Service Category TranslationSearch
Get a Service Module LinkAction
| Field | Type |
|---|---|
Service IDRequired | choice |
Module IDRequired | text |
| Field | Type |
|---|---|
| Link | object |
| Service ID | number |
| Module ID | text |
| External ID | text |
| Metadata | object |
| Created on | date |
| Modified on | date |
| Service | object |
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
Get a StaffAction
| Field | Type |
|---|---|
Staff IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | text |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
| Communication email | text |
| Login email | |
| User role | text |
| Invitation status | text |
Get a Staff Module LinkAction
| Field | Type |
|---|---|
Staff IDRequired | choice |
Module IDRequired | text |
| Field | Type |
|---|---|
| Link | object |
| Staff ID | number |
| Module ID | text |
| External ID | text |
| Metadata | object |
| Created on | text |
| Modified on | text |
| Staff | object |
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
Get a Staff ScheduleAction
Get a TimeslotAction
Get MerchantAction
| Field | Type |
|---|---|
| Language | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Contact first name | text |
| Contact last name | text |
| Phone number | text |
| Tags | text |
Get Service TranslationsSearch
Get Staff Password RecoveryAction
Get Staff User AccessAction
| Field | Type |
|---|---|
Staff IDRequired | choice |
| Field | Type |
|---|---|
| User access | object |
| Staff ID | number |
| Login email | |
| User role | text |
| Provider | text |
| Provider name | text |
| Can login | boolean |
| Last login | date |
| Staff | object |
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
List AvailabilitySearch
| Field | Type |
|---|---|
Search ModeRequired | choice |
| Merchant ID | choice |
| Range | object |
Starts OnRequired | date |
Ends OnRequired | date |
| Booking Items | array |
Service IDRequired | number |
| Only Include Staffs | array |
| Staff ID | number |
| Time Interval (minutes) | number |
| Language | choice |
| Field | Type |
|---|---|
| Availability | object |
| Time selection mode | text |
| Booking time slots | array |
| Booking ranges | array |
| Staffs | array |
| Services | array |
| Resources | array |
| No availability reason | text |
| Cursor | text |
List BookingsSearch
| Field | Type |
|---|---|
| From | date |
| To | date |
| Client ID | choice |
| Merchant ID | choice |
| Booking Method | choice |
| Order | choice |
| Language | choice |
| Limit | number |
| Field | Type |
|---|---|
| Booking ID | text |
| Merchant ID | number |
| Booking method | text |
| Status | text |
| Is completed | boolean |
| Starts on | text |
| Total client timespan | object |
| Start | text |
| End | text |
| Duration | number |
| Staff ID | number |
| Staff first name | text |
| Staff last name | text |
| Items | array |
| Location | text |
| Location text | text |
| Client | object |
| ID | number |
| First name | text |
| Last name | text |
| Home phone number | text |
| Mobile phone number | text |
| Presence | text |
| Remind by email | boolean |
| Remind by sms | boolean |
| Additional request | text |
List ClientsSearch
| Field | Type |
|---|---|
| First Name | text |
| Last Name | text |
| text | |
| Phone Number | text |
| Merchant ID | choice |
| Module ID | text |
| External ID | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Membership number | text |
| Merchant ID | number |
| First name | text |
| Last name | text |
| Language | text |
| Home phone number | text |
| Mobile phone number | text |
| Remind by sms | boolean |
| Remind by email | boolean |
| In mailing list | boolean |
| Date of birth | object |
| Day | number |
| Month | number |
| Year | number |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
List Group EventsSearch
| Field | Type |
|---|---|
From DateRequired | date |
To DateRequired | date |
| Keywords | text |
| Service ID | number |
| Staff ID | choice |
| Minimum Available Places | number |
| Language | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Start | text |
| Duration | number |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Location | text |
| Location text | text |
| Staff ID | number |
| Staff name | text |
| Staff first name | text |
| Staff last name | text |
| Staff | object |
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | text |
| Time selection mode | text |
| Service ID | number |
| Service name | text |
| Service category ID | number |
List Merchant AvailabilitySearch
List Merchant SchedulesSearch
List Merchant Service CategoriesSearch
List Merchant Service CustomizationsSearch
| Field | Type |
|---|---|
| Service ID | choice |
| Staff ID | choice |
| Language | choice |
| Limit | number |
| Field | Type |
|---|---|
| Service ID | number |
| Staff ID | number |
| Has custom duration | boolean |
| Duration | number |
| Has custom price | boolean |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
List Merchant ServicesSearch
| Field | Type |
|---|---|
| Staff ID | choice |
| Booking Method | choice |
| Keywords | text |
| Language | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Has price customization | boolean |
| Category ID | number |
| Category name | text |
List Merchant StaffSearch
List MerchantsSearch
| Field | Type |
|---|---|
| Group ID | number |
| Language | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Contact first name | text |
| Contact last name | text |
| Phone number | text |
| Tags | text |
List Service CategorySearch
List ServicesSearch
| Field | Type |
|---|---|
| External ID | text |
| Module ID | text |
| Merchant ID | choice |
| Service Category ID | choice |
| Tags | text |
| Booking Method | choice |
| Status | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Has price customization | boolean |
| Category ID | number |
| Category name | text |
List Staff CalendarSearch
List Staff SchedulesSearch
List StaffsSearch
| Field | Type |
|---|---|
| External ID | text |
| Module ID | text |
| Merchant ID | choice |
| First Name | text |
| Last Name | text |
| Communication Email | |
| Login Email | |
| Status | choice |
| Personnel Type | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | text |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
| Communication email | |
| Login email | |
| User role | text |
| Invitation status | text |
List TimeslotsSearch
Search MerchantsSearch
| Field | Type |
|---|---|
| Group ID | number |
| Module ID | text |
| External ID | text |
| Limit | number |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Template merchant ID | number |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Contact first name | text |
| Contact last name | text |
| Phone number | text |
| text |
Create a BookingAction
| Field | Type |
|---|---|
| Merchant ID | choice |
Booking MethodRequired | choice |
Starts OnRequired | date |
StatusRequired | text |
| Staff ID | choice |
ItemsRequired | array |
ClientRequired | object |
First NameRequired | text |
Last NameRequired | text |
EmailRequired | |
| Rules | array |
| Ignore Error | array |
| Language | text |
| Field | Type |
|---|---|
| Booking ID | text |
| Merchant ID | number |
| Booking method | text |
| Status | text |
| Is completed | boolean |
| Starts on | text |
| Total client timespan | object |
| Start | text |
| End | text |
| Duration | number |
| Staff ID | number |
| Items | array |
| Location | text |
| Location text | text |
| Client | object |
| ID | number |
| First name | text |
| Last name | text |
| Home phone number | text |
| Mobile phone number | text |
| Presence | text |
| Remind by email | boolean |
| Remind by sms | boolean |
| Additional request | text |
| Payment | object |
| Total | text |
| Paid | text |
| Online payment status | text |
| Created on | date |
Create a ClientAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
First NameRequired | text |
Last NameRequired | text |
Membership NumberRequired | text |
| Date of Birth | object |
DayRequired | number |
MonthRequired | number |
YearRequired | number |
| Home Phone Number | text |
| Mobile Phone Number | text |
| Language | text |
| Remind by SMS | boolean |
| Remind by Email | boolean |
| In Mailing List | boolean |
| Gender | choice |
| Status | choice |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| First name | text |
| Last name | text |
Create a MerchantAction
| Field | Type |
|---|---|
Merchant NameRequired | text |
Template Merchant IDRequired | number |
Group IDRequired | number |
AddressRequired | object |
StreetRequired | text |
CityRequired | text |
StateRequired | text |
Postal CodeRequired | text |
CountryRequired | text |
Contact First NameRequired | text |
Contact Last NameRequired | text |
Phone NumberRequired | text |
EmailRequired | |
Time ZoneRequired | time |
| Push All Services | boolean |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Template merchant ID | number |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Contact first name | text |
| Contact last name | text |
| Phone number | text |
| text |
Create a Merchant ScheduleAction
Create a New ServiceAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
| Name | text |
| Tags | text |
| Spacing After | number |
| Is Busy Spacing After | boolean |
| Duration | number |
| Show Duration | boolean |
| Booking Method | choice |
| Location | choice |
| Location Text | text |
| Max Reservation Size | number |
| Rental Return Mode | text |
| Price | object |
| Visibility | choice |
| Amount | text |
| Amount Per Person | text |
| Amount Per Hour | text |
| Is Starting At | boolean |
| Tax | text |
| Category ID | number |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Has price customization | boolean |
| Category ID | number |
| Category name | text |
Create a Service CategoryAction
Create a StaffAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
| From Staff ID | choice |
| From Staff Template ID | number |
| First Name | text |
| Last Name | text |
| Position | text |
| Biography | text |
| Work Phone | text |
| Communication Email | |
| Mobile Phone | text |
| Personnel Type | text |
| Language | text |
| Status | text |
| Time Selection Mode | text |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
| Communication email | |
| Login email | |
| User role | text |
| Invitation status | text |
Create a Staff ScheduleAction
Create a TimeslotAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
Staff IDRequired | choice |
TypeRequired | text |
StartRequired | date |
EndRequired | date |
| Availability Tags | text |
| Language | choice |
| Field | Type |
|---|---|
| Time slot | object |
| ID | number |
| Merchant ID | number |
| Owner type | text |
| Staff ID | number |
| Type | text |
| Start | date |
| End | date |
| Can modify | boolean |
| Description | text |
| Availability tags | text |
Create Staff Password RecoveryAction
Delete a ClientAction
| Field | Type |
|---|---|
Client IDRequired | choice |
| Ignore Error | boolean |
| Field | Type |
|---|---|
| ID | number |
| Membership number | text |
| Merchant ID | number |
| First name | text |
| Last name | text |
| Language | text |
| Home phone number | text |
| Mobile phone number | text |
| Remind by sms | boolean |
| Remind by email | boolean |
| In mailing list | boolean |
| Date of birth | object |
| Day | number |
| Month | number |
| Year | number |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
Delete a MerchantAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Template merchant ID | number |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Contact first name | text |
| Contact last name | text |
| Phone number | text |
Delete a Merchant ScheduleAction
Delete a ServiceAction
| Field | Type |
|---|---|
Service IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Has price customization | boolean |
| Category ID | number |
| Category name | text |
Delete a Service CategoryAction
Delete a StaffAction
| Field | Type |
|---|---|
Staff IDRequired | choice |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | text |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
| Communication email | text |
| Login email | text |
| User role | text |
| Invitation status | text |
Delete a Staff ScheduleAction
Delete a TimeslotAction
Make an API Calluniversal
Update a BookingAction
| Field | Type |
|---|---|
Booking IDRequired | choice |
| Rules | array |
| Ignore Error | array |
| Language | choice |
| Status | choice |
| Client | object |
| Presence | choice |
| Additional Request | text |
| Is Completed | boolean |
| Staff ID | choice |
| Starts On | date |
| Modified By | text |
| Modified By Staff ID | number |
| Items | array |
| Quick Note | text |
| Field | Type |
|---|---|
| Booking ID | text |
| Merchant ID | number |
| Booking method | text |
| Status | text |
| Is completed | boolean |
| Starts on | date |
| Total client timespan | object |
| Start | text |
| End | text |
| Duration | number |
| Staff ID | number |
| Staff first name | text |
| Staff last name | text |
| Items | array |
| Location | text |
| Location text | text |
| Client | object |
| ID | number |
| First name | text |
| Last name | text |
| text | |
| Home phone number | text |
| Mobile phone number | text |
| Presence | text |
| Remind by email | boolean |
| Remind by sms | boolean |
| Additional request | text |
Update a Booking PaymentAction
Update a ClientAction
| Field | Type |
|---|---|
Client IDRequired | choice |
First NameRequired | text |
Last NameRequired | text |
Membership NumberRequired | text |
| Date of Birth | object |
DayRequired | number |
MonthRequired | number |
YearRequired | number |
| Home Phone Number | text |
| Mobile Phone Number | text |
| Language | text |
| Remind by SMS | boolean |
| Remind by Email | boolean |
| In Mailing List | boolean |
| Gender | choice |
| Status | choice |
| Field | Type |
|---|---|
| ID | number |
| Membership number | text |
| Merchant ID | number |
| First name | text |
| Last name | text |
| Language | text |
| Home phone number | text |
| Mobile phone number | text |
| Remind by sms | boolean |
| Remind by email | boolean |
| In mailing list | boolean |
| Date of birth | object |
| Day | number |
| Month | number |
| Year | number |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
Update a Client Module LinkAction
| Field | Type |
|---|---|
Client IDRequired | choice |
Module IDRequired | text |
| External ID | text |
| Metadata | object |
| Region | text |
| Loyalty Tier | text |
| Field | Type |
|---|---|
| Link | object |
| Module ID | text |
| Client ID | number |
| External ID | text |
| Metadata | object |
| Created on | text |
| Modified on | text |
| Client | object |
| ID | number |
| Merchant ID | number |
| First name | text |
| Last name | text |
| Home phone number | text |
| Mobile phone number | text |
| Metadata | object |
Update a MerchantAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
Is Available OnlineRequired | boolean |
Store NumberRequired | text |
Group Category IDRequired | number |
| Address | object |
StreetRequired | text |
CityRequired | text |
StateRequired | text |
Postal CodeRequired | text |
CountryRequired | text |
| Contact First Name | text |
| Contact Last Name | text |
| Phone Number | text |
| Website URL | url |
| Booking URL | url |
| Description | text |
| Default Language | text |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Template merchant ID | number |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
| Street | text |
| City | text |
| State | text |
| Postal code | text |
| Country | text |
| Contact first name | text |
| Contact last name | text |
| Phone number | text |
Update a Merchant Module LinkAction
| Field | Type |
|---|---|
Merchant IDRequired | choice |
Module IDRequired | text |
| External ID | text |
| Metadata | object |
| Classification | text |
| Field | Type |
|---|---|
| Link | object |
| Merchant ID | number |
| Module ID | text |
| External ID | text |
| Metadata | object |
| Created on | text |
| Modified on | text |
| Merchant | object |
| ID | number |
| Name | text |
| Is available online | boolean |
| Store number | text |
| Template merchant ID | number |
| Group ID | number |
| Group name | text |
| Group category ID | number |
| Group category name | text |
| Address | object |
Update a Merchant ScheduleAction
Update a ServiceAction
| Field | Type |
|---|---|
Service IDRequired | choice |
| Name | text |
| Tags | text |
DurationRequired | number |
| Show Duration | boolean |
| Spacing After | number |
| Is Busy Spacing After | boolean |
Booking MethodRequired | text |
LocationRequired | text |
| Max Reservation Size | number |
| Rental Return Mode | text |
| Location Text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount Per Person | text |
| Amount Per Hour | text |
| Is Starting At | boolean |
| Tax | text |
| Category ID | number |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Has price customization | boolean |
| Category ID | number |
| Category name | text |
Update a Service CategoryAction
Update a Service Category Module LinkAction
| Field | Type |
|---|---|
Service Category IDRequired | choice |
Module IDRequired | text |
External IDRequired | text |
| Metadata | object |
ClassificationRequired | text |
| Field | Type |
|---|---|
| Link | object |
| Service category ID | number |
| Module ID | text |
| External ID | text |
| Metadata | object |
| Created on | text |
| Modified on | text |
| Service category | object |
| ID | number |
| Name | text |
| Description | text |
| Profile image URL | url |
| Merchant ID | number |
| Is template | boolean |
| Service category template ID | number |
Update a Service Module LinkAction
| Field | Type |
|---|---|
Service IDRequired | choice |
Module IDRequired | text |
External IDRequired | text |
| Metadata | object |
ClassificationRequired | text |
| Field | Type |
|---|---|
| Link | object |
| Service ID | number |
| Module ID | text |
| External ID | text |
| Metadata | object |
| Created on | text |
| Modified on | text |
| Service | object |
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
Update a StaffAction
| Field | Type |
|---|---|
Staff IDRequired | choice |
| First Name | text |
| Last Name | text |
| Position | text |
| Biography | text |
| Work Phone | text |
| Communication Email | |
| Mobile Phone | text |
| Language | text |
| Status | text |
| Staff Template ID | number |
| Time Selection Mode | text |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
| Communication email | |
| Login email | |
| User role | text |
| Invitation status | text |
Update a Staff Module LinkAction
| Field | Type |
|---|---|
Staff IDRequired | choice |
Module IDRequired | text |
External IDRequired | text |
| Metadata | object |
ClassificationRequired | text |
| Field | Type |
|---|---|
| Link | object |
| Staff ID | number |
| Module ID | text |
| External ID | text |
| Metadata | object |
| Created on | text |
| Modified on | text |
| Staff | object |
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
Update a Staff ScheduleAction
Update Service Category TranslationAction
Update Service TranslationsAction
Update Staff User AccessAction
| Field | Type |
|---|---|
Staff IDRequired | choice |
| Send Email Invite | boolean |
| User Role | text |
| Can Login | boolean |
| Login Email |
| Field | Type |
|---|---|
| User access | object |
| Staff ID | number |
| Login email | |
| User role | text |
| Provider | text |
| Provider name | text |
| Can login | boolean |
| Last login | date |
| Staff | object |
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
Upload a Service ImageAction
| Field | Type |
|---|---|
Service IDRequired | choice |
| Image | text |
| Field | Type |
|---|---|
| ID | number |
| Merchant ID | number |
| Name | text |
| Tags | text |
| Duration | number |
| Show duration | boolean |
| Has duration customization | boolean |
| Booking method | text |
| Location | text |
| Location text | text |
| Price | object |
| Visibility | text |
| Amount | text |
| Amount per person | text |
| Amount per hour | text |
| Currency | text |
| Is starting at | boolean |
| Tax | text |
| Has price customization | boolean |
| Category ID | number |
| Category name | text |
Upload Service Category ImageAction
Upload Staff ImageAction
| Field | Type |
|---|---|
Staff IDRequired | choice |
| Image | text |
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| First name | text |
| Last name | text |
| Position | text |
| Biography | text |
| Profile image URL | url |
| Time selection mode | text |
| Mobile phone | text |
| Work phone | text |
| Communication email | |
| Login email | |
| User role | text |
| Invitation status | text |
Templates
Look for Booxi templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Appointedd[2]Online booking and appointment scheduling for retail and service businesses.
- Acuity SchedulingOnline appointment scheduling for service businesses and calendars.
- AgendizeOnline appointment scheduling and customer engagement platform for businesses.
- AmeliaWordPress booking and appointment scheduling for services and events.
- AgendaProSalon and clinic booking, payments, and client management.
References
- WEXTL® Booxi Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Booxi.
- WEXTL® visual workflow builder data.
Last updated: Jul 22, 2026 23:18
