Skip to main content
Every wix.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

​
Automations

​
bulkUpdateStorageItemTags

automations.bulkUpdateStorageItemTags Tool to bulk update tags on multiple storage items in Wix automations. Use when you need to set public and/or private tags on multiple storage items at once. Requires ‘Set Up Automations’ permission. Risk: write
Input Output

​
bulkUpdateStorageItemTagsByFilter

automations.bulkUpdateStorageItemTagsByFilter Tool to bulk update tags on storage items matching filter criteria. Use when you need to add or remove tags from multiple storage items at once based on filter conditions. If a tag appears in both assign and unassign, it will be assigned. This operation is asynchronous and triggers the Storage Item Tags Modified event. Risk: write
Input Output

​
cancelEvent

automations.cancelEvent Tool to cancel any remaining automation actions for a trigger and external entity. Use when you need to stop automation workflows that are no longer relevant (e.g., after an invoice is paid or a form submission is processed). Risk: write
Input Output: empty object

​
Benefits

​
bulkDeleteBenefitItems

benefits.bulkDeleteBenefitItems Tool to bulk delete benefit items from Wix Benefit Programs. Use when you need to remove multiple benefit items at once by providing their IDs. Risk: destructive · Irreversible
Input Output

​
bulkDeleteBenefitItemsByFilter

benefits.bulkDeleteBenefitItemsByFilter Tool to bulk delete benefit program items by filter criteria. Use when you need to delete multiple items matching specific conditions within a namespace. If no filter is provided, this may delete all items in the namespace. Risk: destructive · Irreversible
Input Output

​
bulkDeletePoolDefinitions

benefits.bulkDeletePoolDefinitions Tool to bulk delete pool definitions from Wix Benefit Programs. Use when you need to remove multiple pool definitions by their IDs in a single operation. Risk: destructive · Irreversible
Input Output

​
deleteProgramDefinition

benefits.deleteProgramDefinition Tool to delete a program definition from Wix Benefit Programs. Use when you need to permanently remove a benefit program definition by its ID. Risk: destructive · Irreversible
Input Output: empty object

​
Billing

​
bulkDeleteBillableItems

billing.bulkDeleteBillableItems Tool to bulk delete billable items in Wix. Use when you need to remove multiple billable items at once by providing their IDs. This triggers a Billable Item Deleted event in the Wix system. Risk: destructive · Irreversible
Input Output

​
bulkUpdateBillableItems

billing.bulkUpdateBillableItems Tool to bulk update billable items in Wix. Use when you need to modify multiple billable items at once. Each item requires its ID, current revision number, and the fields to update. Risk: write
Input
Output

​
createTaxRegion

billing.createTaxRegion Tool to create a tax region in Wix using the Tax Regions API. Use when you need to define a location-specific tax treatment by country and subdivision with an associated tax calculator. Risk: write
Input
Output

​
deleteReceiptPreset

billing.deleteReceiptPreset Tool to permanently delete a receipt preset from Wix. Use when you need to remove a receipt preset by its ID. This triggers a Receipt Preset Deleted event in the Wix system. Risk: destructive · Irreversible
Input Output: empty object

​
listDefaultTaxGroups

billing.listDefaultTaxGroups Tool to retrieve the list of default tax groups for a Wix site. Use when you need to fetch the default tax groups that are inherited by apps installed on the site. Risk: read
Input Output

​
listDefaultTaxGroupsByAppIds

billing.listDefaultTaxGroupsByAppIds Tool to retrieve default tax groups for specific Wix apps by their app IDs. Use when you need to fetch predefined tax groups that are automatically assigned to products from specific apps. Risk: read
Input Output

​
listManualTaxMappings

billing.listManualTaxMappings Tool to retrieve up to 1,000 manual tax mappings from Wix. Use when you need to list custom tax rate configurations for specific tax group and region combinations. Results are sorted by createdDate in ascending order. Risk: read
Input Output

​
queryManualTaxMappings

billing.queryManualTaxMappings Tool to retrieve a list of up to 100 manual tax mappings with optional paging, filtering, and sorting. Use when you need to query custom tax rate configurations for specific tax group and region combinations from a Wix store. Risk: read
Input
Output

​
queryTaxGroups

billing.queryTaxGroups Tool to retrieve a list of up to 100 tax groups with optional paging, filtering, and sorting. Only returns tax groups created by the site, not default tax groups. Use when you need to fetch custom tax group configurations from a Wix site. Risk: read
Input
Output

​
setDefaultReceiptPreset

billing.setDefaultReceiptPreset Tool to set a receipt preset as the default in Wix. Use when you need to designate a specific receipt preset as the default for receipt generation. Risk: write
Input Output

​
updateReceiptPreset

billing.updateReceiptPreset Tool to update a receipt preset in Wix. Use when you need to modify receipt preset settings including name, custom fields, display settings, or extended fields. Requires the current revision number to prevent conflicting changes. Triggers a Receipt Preset Updated event. Risk: write
Input
Output

​
Bookings

​
bulkDeleteServices

bookings.bulkDeleteServices Tool to bulk delete services from Wix Bookings. Use when you need to remove multiple services at once by providing their IDs. Risk: destructive · Irreversible
Input Output

​
bulkDeleteServicesByFilter

bookings.bulkDeleteServicesByFilter Tool to bulk delete booking services by filter criteria. The operation succeeds even if individual services can be deleted, with failure information returned in bulkActionMetadata. Triggers Service Deleted webhook for each successfully deleted service. Risk: destructive · Irreversible
Input Output

​
countExtendedBookings

bookings.countExtendedBookings Tool to count extended bookings matching specified filter criteria. Use when you need to get the total number of bookings without retrieving the full booking data. Note: unlike query endpoints, the filter is sent at the top level of the body, not wrapped in a query envelope. Risk: read
Input Output

​
deleteAddOnGroup

bookings.deleteAddOnGroup Tool to delete an add-on group from a Wix Bookings service. Use when you need to remove an add-on group from a specific service by providing the service ID and add-on group ID. Risk: destructive · Irreversible
Input Output: empty object

​
deleteService

bookings.deleteService Tool to delete a service from Wix Bookings. Use when you need to remove a single service by its ID. Triggers a Service Deleted event upon success. Risk: destructive · Irreversible
Input Output: empty object

​
listSessions

bookings.listSessions Tool to retrieve calendar sessions from Wix Bookings with filtering, sorting, and pagination. Use when you need to list booking sessions, event instances, or availability slots. Note: This endpoint is deprecated and may be replaced with newer Calendar V3 APIs. Risk: read
Input Output

​
queryCategories

bookings.queryCategories Tool to retrieve bookings service categories with optional filtering, sorting, and pagination. Use when you need to fetch categories that organize booking services in Wix Bookings. Risk: read
Input
Output

​
queryExtendedBookings

bookings.queryExtendedBookings Tool to retrieve up to 100 extended bookings with advanced filtering, sorting, and pagination. Use when you need to search for specific bookings with attendance details and customer action permissions. Default behavior returns 50 bookings sorted by id in ascending order. Risk: read
Input
Output

​
updateStaffMemberTagsByFilter

bookings.updateStaffMemberTagsByFilter Tool to bulk update tags on Wix Bookings staff members by filter criteria. Use when you need to add or remove tags from multiple staff members matching specific conditions. If a tag appears in both assign and unassign, it will be assigned. Risk: write
Input Output

​
Cms

​
addSpecialPermissions

cms.addSpecialPermissions Tool to add special permissions to a Wix data collection for a specific user or role. Use when you need to grant CRUD permissions (insert, update, remove, read) to a user or role for a specific collection. Risk: write
Input
Output: empty object

​
cancelTask

cms.cancelTask Tool to cancel a background task in Wix CMS. Use when you need to stop a running background task that is no longer needed. Risk: write
Input Output: empty object

​
deleteDataCollectionField

cms.deleteDataCollectionField Tool to delete a field from a Wix data collection. Use when you need to remove a field from a collection’s structure, which also removes all associated values. The operation is idempotent and succeeds even if the collection or field doesn’t exist. Risk: destructive · Irreversible
Input Output: empty object

​
deleteUserDefinedFields

cms.deleteUserDefinedFields Tool to delete user defined fields from a data extension schema in Wix. Use when you need to remove custom fields from a schema by providing the schema ID and field keys. Risk: destructive · Irreversible
Input Output: empty object

​
Community

​
bulkUpdateReviewModerationStatus

community.bulkUpdateReviewModerationStatus Tool to bulk update the moderation status of multiple reviews at once. All filtered reviews are updated to the same moderation status. Use when you need to moderate multiple reviews efficiently instead of updating them one by one. Risk: write
Input Output

​
checkContent

community.checkContent Tool to check content text against Wix moderation rules. Use when you need to validate user-submitted content for policy violations before publishing or to determine if content requires moderation. Risk: read
Input Output

​
deleteFaqCategory

community.deleteFaqCategory Tool to delete an FAQ category from the Wix site. Deleting a category permanently removes it and all associated questions from the FAQ page. Triggers a Category Deleted event. Risk: destructive · Irreversible
Input Output: empty object

​
deleteQuestionEntry

community.deleteQuestionEntry Tool to delete a question entry from Wix FAQ app. Use when you need to permanently remove a FAQ question entry by its ID. Risk: destructive · Irreversible
Input Output: empty object

​
listGroupRequests

community.listGroupRequests Tool to list group requests across a Wix site. Use when you need to retrieve pending or processed requests for group creation. Only admins can see create group requests; members can access their own requests. Risk: read
Input Output

​
queryGroupRequests

community.queryGroupRequests Tool to query group creation requests with filtering, sorting, and pagination. Use when you need to retrieve pending, approved, or rejected group requests from site members. Risk: read
Input
Output

​
queryModerationRules

community.queryModerationRules Tool to retrieve moderation rules with optional filtering, sorting, and pagination. Use when you need to fetch rules that manage user-generated content moderation on a Wix site. Returns up to 1000 rules per request. Risk: read
Input
Output

​
updateModerationRule

community.updateModerationRule Tool to update a moderation rule in Wix Community Feedback Moderation. Use when you need to modify an existing rule’s settings such as name, enabled status, or configuration. Requires the current revision number to prevent conflicts. Risk: write
Input
Output

​
updateQuestionEntryLabels

community.updateQuestionEntryLabels Tool to set labels for a Wix FAQ question entry. Use when a question entry is updated and you need to modify its labels. This operation replaces all existing labels with the provided list. Risk: write
Input Output

​
updateReviewModerationStatus

community.updateReviewModerationStatus Tool to update the moderation status of a review. Use when you need to approve, reject, or change the moderation status of a specific review. Risk: write
Input Output

​
Contacts

​
addLabels

contacts.addLabels Tool to add labels to a Wix contact using the Labels API. Use when you need to categorize or tag contacts with specific labels like ‘contacts.customers’ or ‘contacts.contacted-me’. Risk: write
Input Output

​
bulkUpdate

contacts.bulkUpdate Tool to bulk update multiple contacts with specified field values. Use when you need to update the same field(s) across multiple contacts matching a filter or search criteria. Only fields specified in fieldMask.paths will be updated. Risk: write
Input
Output

​
list

contacts.list Tool to retrieve a list of up to 1,000 contacts per request from Wix. Use when you need to fetch contact information with support for pagination and field filtering. Risk: read
Input Output

​
listFacets

contacts.listFacets Tool to list facets from the site’s Contact List. Facets include labels, subscription statuses (email and SMS), and membership statuses. Use when you need to retrieve available contact categorization options with their counts. Risk: read
Input Output

​
query

contacts.query Tool to retrieve up to 1,000 Wix contacts with advanced filtering, sorting, and pagination. Use when you need to search for specific contacts or retrieve contacts with custom field selections. Risk: read
Input
Output

​
queryFacets

contacts.queryFacets Tool to retrieve facets from the site’s contact list by filter. Facets include labels and subscription statuses with aggregated contact counts. Use when you need to get contact segmentation data. Risk: read
Input
Output

​
unlabel

contacts.unlabel Tool to remove labels from a contact in the Wix CRM system. Use when you need to unlabel a contact by removing specific label keys. This triggers a Contact Updated event in the Wix system. Risk: write
Input Output

​
Events

​
bulkDeleteRsvpsByFilter

events.bulkDeleteRsvpsByFilter Tool to bulk delete event RSVPs by filter criteria. Use when you need to remove multiple RSVPs matching specific conditions. If no filter is provided, this may delete all RSVPs. Risk: destructive · Irreversible
Input Output

​
bulkDeleteTicketDefinitions

events.bulkDeleteTicketDefinitions Tool to bulk delete ticket definitions by filter criteria for Wix Events. Use when you need to delete multiple ticket definitions matching specific conditions. Requires ‘Manage Ticket Definitions’ permission. Risk: destructive · Irreversible
Input Output

​
bulkUnassignFromCategories

events.bulkUnassignFromCategories Tool to unassign an event from multiple categories in Wix Events. Use when you need to remove an event from one or more categories by providing the event ID and category IDs. Risk: write
Input Output: empty object

​
deleteScheduleBookmark

events.deleteScheduleBookmark Tool to remove a bookmark from a schedule item in Wix Events. Use when you need to delete a user’s saved bookmark for a specific event schedule item. Risk: destructive · Irreversible
Input Output: empty object

​
deleteScheduleItem

events.deleteScheduleItem Tool to delete schedule items from a Wix event. Use when you need to remove one or more schedule items from an event’s draft schedule. Risk: destructive · Irreversible
Input Output: empty object

​
deleteTicketCheckIn

events.deleteTicketCheckIn Tool to delete ticket check-in records for Wix Events. Use when you need to remove check-in status for one or more tickets at an event. Risk: write
Input Output: empty object

​
deleteTicketReservation

events.deleteTicketReservation Tool to delete a ticket reservation from Wix Events. Use when you need to remove a ticket reservation that is no longer needed or valid. Risk: destructive · Irreversible
Input Output: empty object

​
discardDraft

events.discardDraft Tool to discard all changes to a draft schedule for a Wix event. Use when you need to revert all unsaved changes and restore the schedule to its published state. Requires ‘Manage Events - all permissions’ scope. Risk: write
Input Output: empty object

​
find

events.find Tool to find a Wix event by ID or slug. Use when you need to retrieve event details. Note: This endpoint is deprecated and will be replaced by Events V3 Get Event. Risk: read
Input Output

​
publishDraft

events.publishDraft Tool to publish a draft schedule for a Wix event. Use when you need to make all draft changes live and visible to site visitors. Requires Manage Events - all permissions scope. Risk: write
Input Output: empty object

​
queryEventsGraphql

events.queryEventsGraphql Tool to query events using the deprecated eventsEvents GraphQL endpoint. Returns event items and pagination info. Note: This endpoint is deprecated and will be replaced with Events V3 Query Events endpoint. Risk: read
Input
Output

​
rescheduleDraft

events.rescheduleDraft Tool to reschedule all draft schedule items for an event at once. Use when you need to adjust the time of multiple draft schedule items simultaneously by specifying a new time zone. Risk: write
Input Output: empty object

​
Forms

​
bulkDeleteSchemas

forms.bulkDeleteSchemas Tool to bulk delete form schemas from Wix Forms. Use when you need to remove multiple forms by their IDs in a single operation. Risk: destructive · Irreversible
Input Output

​
queryDeletedForms

forms.queryDeletedForms Tool to retrieve deleted form schemas from the trash bin for a specified namespace. Use when you need to query forms that have been deleted but not permanently removed. Requires namespace filter. Risk: read
Input
Output

​
queryFormsSubmissions

forms.queryFormsSubmissions Tool to retrieve form submissions from a specified namespace with optional pagination. Use when you need to query form submissions from Wix Forms or other form apps. The namespace filter is required. Risk: read
Input
Output

​
querySubmissionsByNamespace

forms.querySubmissionsByNamespace Tool to retrieve form submissions from a specified namespace with advanced filtering, sorting, and pagination. Use when you need to query submissions with specific criteria like status, date ranges, or visibility. Namespace filter is required using $eq operator. Risk: read
Input
Output

​
removeDeletedFields

forms.removeDeletedFields Tool to permanently remove deleted fields from a Wix form schema. Use when you need to clean up deleted fields from a form. Risk: destructive · Irreversible
Input Output

​
Marketing

​
deleteLoyaltyCoupon

marketing.deleteLoyaltyCoupon Tool to delete a loyalty coupon from the Wix Loyalty Program. Note that deleting a loyalty coupon does not affect the functionality of the corresponding discount coupon itself. Use when you need to remove a loyalty coupon by its unique identifier. Risk: destructive · Irreversible
Input Output: empty object

​
deleteSenderDetails

marketing.deleteSenderDetails Tool to delete sender details from Wix email marketing. Use when you need to remove a sender from the available senders list. Note: You cannot delete a default sender - you must first create a new sender and mark it as default before deleting the original. Risk: destructive · Irreversible
Input Output: empty object

​
deleteSenderEmail

marketing.deleteSenderEmail Tool to delete a sender email from Wix Marketing. Use when you need to remove a specific sender email by its ID. Risk: destructive · Irreversible
Input Output: empty object

​
enablePointsExpiration

marketing.enablePointsExpiration Tool to enable points expiration for a Wix loyalty program. Use when you need to activate the points expiration feature, which changes the pointsExpiration status to ENABLED. Risk: write
Input Output

​
getCurrentMemberCoupons

marketing.getCurrentMemberCoupons Tool to retrieve loyalty coupons for the currently authenticated member. Use when you need to fetch loyalty program coupons for the logged-in member. Requires visitor or member authentication. Risk: read
Input Output

​
getSenderDetails

marketing.getSenderDetails Tool to retrieve sender details for email marketing campaigns. Use when you need to fetch the sender name and email address. Note: This endpoint is deprecated and has been superseded by the Get Default Sender Details endpoint. Risk: read
Input Output

​
listCampaigns

marketing.listCampaigns Tool to retrieve a list of email marketing campaigns, ordered by date_updated in descending order. Use when you need to get campaigns from Wix Email Marketing with optional filtering by status, visibility, or distribution status. Risk: read
Input Output

​
queryLoyaltyCheckoutDiscounts

marketing.queryLoyaltyCheckoutDiscounts Tool to retrieve loyalty checkout discounts with filtering, sorting, and pagination. Use when you need to query discounts applied at checkout using loyalty points. Risk: read
Input
Output

​
updateReferralProgram

marketing.updateReferralProgram Tool to update a site’s referral program configuration including name, rewards, and email settings. Use when you need to modify an existing referral program. The revision field is required to prevent conflicting updates. Risk: write
Input
Output

​
Media

​
generateFilesDownloadUrl

media.generateFilesDownloadUrl Tool to generate download URLs for files in Wix Media Manager. Use when you need to create a permanent download URL for one or multiple files (up to 1000). Returns a download URL for a compressed file containing all requested files. Risk: read
Input Output

​
generateFileUploadUrl

media.generateFileUploadUrl Tool to generate an upload URL for uploading files to Wix Media Manager. Use when you need to upload a file to Wix. Note: Files are not immediately available after upload and require processing time. For files larger than 10MB or poor network conditions, use Generate File Resumable Upload URL instead. Risk: write
Input Output

​
importFile

media.importFile Tool to import a file to Wix Media Manager using an external URL. Use when you need to add a file from an external source to the Media Manager. Note: imported files take time to process and are not immediately available (state=PENDING initially). Risk: write
Input Output

​
Members

​
get

members.get Tool to retrieve a member by ID from Wix Members. Use when you need to fetch detailed information about a specific member. Note: Private members (default privacy status) are not returned for site visitor or member calls. Risk: read
Input Output

​
getMembersCustomFieldApplications

members.getMembersCustomFieldApplications Tool to retrieve custom field applications for specified members. Use when you need to check which custom field applications apply to specific members. Risk: read
Input Output

​
getPrivacySettings

members.getPrivacySettings Tool to retrieve member privacy settings for a Wix site. Use when you need to check what privacy settings are currently configured, including whether members can make their profiles public. Risk: read
Input Output

​
getRolesCustomFieldApplications

members.getRolesCustomFieldApplications Tool to retrieve custom field applications for specified roles. Use when you need to check which custom field applications apply to specific member roles. Risk: read
Input Output

​
getRolesInfo

members.getRolesInfo Tool to retrieve all available roles in the requesting Wix account, including predefined and custom roles. Use when you need to list all roles configured for the account. Risk: read
Input Output

​
listCustomFields

members.listCustomFields Tool to retrieve a list of custom fields and fields provided by the Members Area. Use when you need to fetch available custom field definitions for member profiles. Fields are ordered by section and creation date. Risk: read
Input Output

​
listFollowing

members.listFollowing Tool to retrieve the list of members followed by a given member in Wix Members. Use when you need to see which members a specific member is following. Note: This API is in Developer Preview and may be subject to change. Risk: read
Input Output

​
listMyFollowers

members.listMyFollowers Tool to retrieve the list of members who are following the current authenticated member in Wix Members. Use when you need to see which members follow the current user. Risk: read
Input Output

​
logout

members.logout Tool to terminate a member’s session and clear authentication cookies. Use when you need to log out a user from their Wix session. When postLogoutRedirectUri is provided, returns a 302 redirect response. Risk: write
Input Output: empty object

​
register

members.register Tool to register a new member account on Wix site. Use when you need to create a new member with email and password authentication. Returns a session token that can be used to obtain access and refresh tokens. Risk: write
Input
Output

​
sendRecoveryEmail

members.sendRecoveryEmail Tool to send a password recovery email to a Wix member with a link to reset their password. Use when a member needs to reset their password. The site must be published for this to work. Site owners will reset their Wix account password instead of site-specific password. Risk: write
Input Output: empty object

​
Multilingual

​
bulkDeleteTranslationContent

multilingual.bulkDeleteTranslationContent Tool to bulk delete translation content by IDs. Use when you need to delete multiple translation content items in a single operation. Risk: destructive · Irreversible
Input Output

​
bulkUpdateTranslationContentByKey

multilingual.bulkUpdateTranslationContentByKey Tool to bulk update translation content by composite key (schemaId, entityId, locale). Use when updating translatable fields for multiple content items identified by their schema, entity, and locale combination. Triggers Content Updated event on success. Risk: write
Input
Output

​
Orders

​
bulkDeleteAbandonedCheckouts

orders.bulkDeleteAbandonedCheckouts Tool to bulk delete abandoned checkouts from Wix e-commerce. Use when you need to remove multiple abandoned checkouts by their IDs. Risk: destructive · Irreversible
Input Output

​
bulkUpdate

orders.bulkUpdate Tool to bulk update properties of up to 100 e-commerce orders. Use when you need to update order fields like archived status, buyer information, billing/shipping addresses, or custom fields. To remove a field, pass null; note that buyerInfo and contactDetails cannot be removed. Risk: write
Input
Output

​
bulkUpdateTags

orders.bulkUpdateTags Tool to synchronously update tags on multiple orders by list of order IDs. Use when you need to add or remove tags from multiple orders at once. If a tag appears in both assignTags and unassignTags, it will be assigned. Risk: write
Input Output

​
listInvoicesByOrderIds

orders.listInvoicesByOrderIds Tool to retrieve invoice IDs and external app IDs for multiple orders. Use when you need to get invoice information associated with one or more Wix eCommerce orders. Risk: read
Input Output

​
query

orders.query Tool to retrieve e-commerce orders with advanced filtering, sorting, and pagination. Use when you need to search for specific orders or retrieve order lists. Default behavior excludes orders with status ‘INITIALIZED’. Risk: read
Input
Output

​
removeTip

orders.removeTip Tool to remove a tip from an existing eCommerce order. Use when you need to remove tip charges that were previously added to an order. Risk: write
Input Output

​
Portfolio

​
deleteProject

portfolio.deleteProject Tool to delete a project from Wix Portfolio. Use when you need to remove a specific project by its ID. Note: This operation may return an empty success response when the Portfolio app is not installed. Risk: destructive · Irreversible
Input Output: empty object

​
deleteProjectItem

portfolio.deleteProjectItem Tool to delete a project item from the Wix Portfolio. Use when you need to permanently remove a portfolio project item by its ID. Risk: destructive · Irreversible
Input Output: empty object

​
Restaurants

​
bulkDeleteModifiers

restaurants.bulkDeleteModifiers Tool to bulk delete item modifiers from Wix Restaurants Menus. Use when you need to remove multiple item modifiers at once by providing their IDs. Risk: destructive · Irreversible
Input Output

​
bulkDeleteNotificationRecipients

restaurants.bulkDeleteNotificationRecipients Tool to bulk delete notification recipients for Wix Restaurants online orders. Use when you need to remove multiple recipients at once by providing their IDs. Risk: destructive · Irreversible
Input Output

​
bulkDeleteVariants

restaurants.bulkDeleteVariants Tool to bulk delete item variants from Wix Restaurants menus. Use when you need to remove multiple menu item variants at once. Risk: destructive · Irreversible
Input Output

​
calculateFirstAvailableSlots

restaurants.calculateFirstAvailableSlots Tool to calculate and retrieve the first available time slot of each fulfillment type for each specified menu. Use when you need to check availability for restaurant operations. Note: Developer Preview status - API is subject to change. Risk: read
Input Output

​
deleteMenu

restaurants.deleteMenu Tool to delete a menu from Wix Restaurants. Use when you need to permanently remove a menu by its ID. The endpoint implements idempotent DELETE behavior. Risk: destructive · Irreversible
Input Output: empty object

​
deleteServiceFeeRule

restaurants.deleteServiceFeeRule Tool to delete a service fee rule from Wix Restaurants Online Orders. Use when you need to remove a specific rule by its ID. Risk: destructive · Irreversible
Input Output: empty object

​
listCatalogs

restaurants.listCatalogs Tool to retrieve a list of restaurant catalogs from Wix Restaurants. Use when you need to get all catalogs for a restaurant location. Note: This API is deprecated and has been replaced with the Menus API. Risk: read
Input Output

​
Sites

​
checkDomainAvailability

sites.checkDomainAvailability Tool to check if a domain name is available for purchase. Use when you need to verify domain availability before registration. Returns an availability object with a boolean indicating if the domain can be purchased. Risk: read
Input Output

​
getFolderBySite

sites.getFolderBySite Tool to retrieve folder information for a specific site by site ID. Use when you need to get the parent folder details of a site. Note: If the specified site is at root level, the returned folder object will be empty. Risk: read
Input Output

​
getProperties

sites.getProperties Tool to retrieve current snapshot of a site’s properties including business profile, contact information, and business schedule. Use when you need to fetch site-level business information, contact details, or operating hours. Risk: read
Input Output

​
getSitePluginsPlacementStatus

sites.getSitePluginsPlacementStatus Tool to get the placement status of your app’s site plugins on the user’s site. Use when you need to check whether your plugins are currently placed in slots on the user’s site. Risk: read
Input Output

​
queryFolders

sites.queryFolders Tool to retrieve a list of site folders with optional paging, filtering, and sorting. Use when you need to organize and manage Wix sites by folders in an account. Risk: read
Input
Output

​
queryLocations

sites.queryLocations Tool to retrieve business locations with filtering, sorting, and pagination. Use when you need to search for specific locations or list all locations for a site. Risk: read
Input
Output

​
updateBusinessContact

sites.updateBusinessContact Tool to update a site’s business contact information including email, phone, fax, and address. Use when you need to modify the public business contact details displayed on a Wix site. Requires Manage Business Contact permission scope. Risk: write
Input
Output

​
updateBusinessProfile

sites.updateBusinessProfile Tool to update a site’s business profile including display name, description, logo, and business name. Use when you need to modify public business information. Only fields specified in the fields.paths array are updated. Risk: write
Input
Output

​
updateBusinessSchedule

sites.updateBusinessSchedule Tool to update a site’s business schedule including regular operating hours and special exceptions. Use when you need to set or modify business hours, add holiday closures, or define special event hours. The update replaces the entire schedule, so include all desired periods in each request. Risk: write
Input
Output

​
updateLocaleSettings

sites.updateLocaleSettings Tool to update a Wix site’s locale configuration settings including auto-redirect behavior. Use when you need to modify locale settings such as enabling or disabling automatic visitor redirection based on language preferences. Note: This action cannot update a site’s multilingual mode; use the Set Multilingual Mode action for that. Risk: write
Input
Output

​
Stores

​
bulkCreateProductsWithInventory

stores.bulkCreateProductsWithInventory Tool to bulk create products with inventory in Wix. Use when you need to create multiple products with pricing and stock information in a single request. Supports up to 100 products per request. Physical products require physical_properties. Risk: write
Input
Output

​
bulkDeleteBrands

stores.bulkDeleteBrands Tool to delete multiple brands from the Wix Stores catalog. When a brand is deleted, it’s automatically removed from all products that reference it. Use when you need to remove multiple brands at once. Risk: destructive · Irreversible
Input Output

​
bulkDeleteInventoryItems

stores.bulkDeleteInventoryItems Tool to bulk delete inventory items from the Wix Stores catalog. Accepts non-existent IDs without error. Use when you need to remove multiple inventory items at once. Risk: destructive · Irreversible
Input Output

​
bulkDeleteProducts

stores.bulkDeleteProducts Tool to bulk delete products from the Wix Stores catalog. Use when you need to permanently remove multiple products by their IDs. Risk: destructive · Irreversible
Input Output

​
bulkGetOrCreateBrands

stores.bulkGetOrCreateBrands Tool to bulk retrieve or create brands in Wix Stores catalog. Retrieves multiple brands by name, or creates them if they don’t exist. Use when you need to ensure specific brands exist in the catalog. Risk: write
Input Output

​
bulkRemoveInfoSectionsByFilter

stores.bulkRemoveInfoSectionsByFilter Tool to bulk remove info sections from products matching a filter expression. Use when you need to detach information sections from multiple products based on specific criteria like visibility status, creation date, or other product attributes. Risk: destructive · Irreversible
Input Output

​
bulkUpdateCustomizations

stores.bulkUpdateCustomizations Tool to bulk update multiple customizations in Wix Stores Catalog V3. Use when you need to update properties of existing customizations such as name, type, choices, or settings. Each update requires the current revision number to prevent conflicts. Risk: write
Input
Output

​
bulkUpdateInventoryItemsByFilter

stores.bulkUpdateInventoryItemsByFilter Tool to bulk update inventory items by filter criteria. Updates multiple inventory items matching the specified filter (e.g., by productId). Use when you need to change inventory tracking settings, stock status, or quantities for multiple items at once. Risk: write
Input
Output

​
bulkUpdateProductsByFilter

stores.bulkUpdateProductsByFilter Tool to bulk update multiple products matching filter criteria in Wix Stores. Use when you need to update the same field(s) across multiple products matching specific conditions. Cannot update slug, options, modifiers, or variantsInfo fields. Risk: write
Input
Output

​
deleteBackInStockNotification

stores.deleteBackInStockNotification Tool to delete a back in stock notification request from Wix e-commerce. Use when you need to remove a customer request to be notified when a product comes back in stock. Risk: destructive · Irreversible
Input Output: empty object

​
deleteCustomization

stores.deleteCustomization Tool to delete a customization from the Wix Stores catalog. Use when you need to permanently remove a customization option by its ID. Risk: destructive · Irreversible
Input Output: empty object

​
deleteInfoSection

stores.deleteInfoSection Tool to delete an info section from the Wix Stores catalog. Use when you need to permanently remove a specific info section by its ID. Risk: destructive · Irreversible
Input Output: empty object

​
deleteProductOptions

stores.deleteProductOptions Tool to delete all options from a Wix product. Use when you need to remove all product options (like Color, Size) and reset the product to a single default variant. Only works when variant management is disabled. Risk: destructive · Irreversible
Input Output

​
getCollectionBySlug

stores.getCollectionBySlug Tool to retrieve a Wix Stores collection by its slug. Use when you need to fetch collection details using the collection’s URL-friendly identifier instead of its ID. Risk: read
Input Output

​
listCurrencies

stores.listCurrencies Tool to retrieve the list of available currencies from Wix Currency Converter. Use when you need to get all supported currencies with their ISO codes and symbols. Risk: read
Input Output

​
queryCoupons

stores.queryCoupons Tool to retrieve a list of up to 100 coupons with optional paging, filtering, and sorting. Use when you need to fetch coupons from a Wix store. Risk: read
Input
Output

​
queryInventory

stores.queryInventory Tool to retrieve a list of up to 1000 inventory items with optional paging, filtering, and sorting. Manages inventory per variant including stock quantities, availability status, and preorder information. Use when you need to fetch inventory data from a Wix Stores Catalog V3 site. Risk: read
Input
Output

​
searchProducts

stores.searchProducts Tool to search products in the Wix store catalog using text search, filters, and sorting. Returns up to 100 products per request with cursor-based pagination. Use when you need to find specific products or retrieve products matching certain criteria. Risk: read
Input
Output

​
setCustomizationChoices

stores.setCustomizationChoices Tool to set choices for a customization in Wix stores catalog. Use when you need to replace all existing choices with a new set of choices for a customization. This operation requires a valid GUID customization ID and at least one choice with a name. Risk: write
Input
Output

​
updateInventoryVariants

stores.updateInventoryVariants Tool to update product inventory including quantity, stock status, and tracking settings per variant. Use when you need to modify inventory levels or stock configuration. The revision field must match the current value to prevent conflicts. Risk: write
Input
Output

​
System

​
bulkDeleteReportsByFilter

system.bulkDeleteReportsByFilter Tool to bulk delete reports from the dashboard by filter criteria. Use when you need to remove multiple reports matching specific conditions. Triggers a Report Deleted event for each removed report. Risk: destructive · Irreversible
Input Output

​
deleteSecret

system.deleteSecret Tool to delete a secret from Wix Secrets Vault. Use when you need to permanently remove a secret by its GUID identifier. Risk: destructive · Irreversible
Input Output: empty object

​
deleteUserFavorite

system.deleteUserFavorite Tool to remove a dashboard page from the current user’s list of favorite pages. Use when you need to delete a specific favorite from the user’s dashboard. The API exhibits idempotent behavior - returns success even if the favorite doesn’t exist. Risk: destructive · Irreversible
Input Output: empty object

​
getAppInstance

system.getAppInstance Tool to retrieve the current app instance details and associated site information. Use when you need to fetch app configuration, permissions, or site details. Risk: read
Input Output

​
getPurchaseHistory

system.getPurchaseHistory Tool to retrieve purchase history for your app on a site. Use when you need to view past purchases and verify upgrades. Note: The response does not include cancellation details. Site context is automatically derived from authentication. Risk: read
Input Output

​
listAppPermissions

system.listAppPermissions Tool to retrieve all permissions for a specified Wix app. Use when you need to list the permissions your app requests when users install it on a site. Risk: read
Input Output

​
listAppPlansByAppId

system.listAppPlansByAppId Tool to retrieve app plans by application ID, including pricing, tax settings, and currency details. Use when you need to fetch pricing plans for a specific Wix app. Note: Only returns activated plans; externally managed plans are excluded. For yearly plans, returns monthly payment amount (multiply by 12 for total). Risk: read
Input Output

​
updateOperationGroupTagsByFilter

system.updateOperationGroupTagsByFilter Tool to bulk update tags on operation groups using filter criteria. Use when you need to add or remove tags from multiple operation groups matching specific conditions. If a tag appears in both assign and unassign, it will be assigned. Risk: write
Input Output