About Developer Preview

Wix is always in active development, constantly adding new APIs. To ensure we're building the functionality you need, some APIs are released in Developer Preview mode for developer testing and feedback before full release.

APIs in Developer Preview mode include the following note in their introductions. When this note is removed, the API is fully released.

Breaking changes

APIs in Developer Preview are still in development. This means that Wix may change them at any time. Notifications about breaking changes appear in the changelog and in the API reference for the affected methods and properties. Wix won't contact you directly about breaking changes.

Because Wix may introduce breaking changes to these APIs, you shouldn't use them on live sites. They're for testing and feedback purposes only.

Time limit

APIs only stay in Developer Preview mode for a maximum of 6 months. After that, they're fully released, and Wix won't make any breaking changes to them.

Feedback

We would appreciate your feedback on the APIs in Developer Preview. Let us know about:

• What you're using the API for.
• Anything blocking you from using the API.
• Additions and features you would find useful.

Please contact us with your feedback.

Bugs

If you discover a bug in a Developer Preview API, please contact us and let us know. We'll fix the bug as soon as possible.

Methods in developer preview

The following methods are currently in developer preview:

AI Credits

Method	Description
Get Balance	Retrieves an account's current AI credit balance.

Account Certification V1

Method	Description
Query Account Certifications	Retrieves a list of up to 1,000 account certifications, given the provided paging, filtering, and sorting.
List Account Certifications	Retrieves an account's certifications for public display, given the account ID.

Account V1

Method	Description
Get Connect Url	Retrieves a channel's OAuth authorization URL that a site owner opens to connect the channel.
Get Long Lived Token Status	Retrieves the connection status of a site's social channel account.
List Accounts	Retrieves the connected accounts for a social channel.
Disconnect	Disconnects a social channel account from the site.
Update Account Settings	Updates the settings for a connected social channel account, such as the default page, board, or account to publish to.

Accounts

Method	Description
Connect Account	This endpoint is used to connect a merchant's Payment Service Provider (PSP) account to a Wix site.

Action Catalog

Method	Description
Get Action	Retrieves a specific version of an action by ID.
Create Action	Creates an action for the specified app
Update Action	Updates the specified action for the specified app.
Delete Action	Deletes an action from the specified app.
Get Runtime Action	Retrieves the version of an action that's currently active on the site.
Get Latest Action	Retrieves the latest version of an action, regardless of the site on which it's installed.
Get Action Dynamic Input Schema	Retrieves an action's dynamic input schema and UI schema, based on the action's input mapping.
Copy Input Mapping	Retrieves a copy of an action's input mapping, with any per-action unique values regenerated.
Get Action Dynamic Output Schema	Retrieves an action's dynamic output schema, based on the action's input mapping.
Bulk Get Action Dynamic Output Schemas	Retrieves dynamic output schemas for multiple actions in a single request.
Generate Input Mapping From Intent	Generates an action's input mapping from a natural language description of the desired configuration.
Query Actions	Retrieves a list of actions, based on the provided paging, filtering, and sorting.
Query Latest Actions	Retrieves a list of the latest version of each action, based on the provided paging, filtering, and sorting.

Action Provider Service Plugin

Method	Description
Validate Configuration	This method is used to validate a Wix user's action configuration.
Get Quota Info	This method retrieves quota information for an action.
Invoke	Runs your action.

Add-Ons

Method	Description
Create Add On	Creates an add-on.
Get Add On	Retrieves an add-on.
Delete Add On	Deletes an add-on and removes it from all add-on groups.
Update Add On	Updates an existing add-on.
Query Add Ons	Retrieves up to 100 add-ons, given the specified filtering, sorting, and paging.
Bulk Create Add Ons	Creates multiple add-ons in a single request.
Bulk Update Add Ons	Updates multiple add-ons in a single request.
Bulk Delete Add Ons	Deletes multiple add-ons in a single request.

Additional Fees Service Plugin

Method	Description
Calculate Additional Fees	Requests calculation of additional fees from the service plugin implementer for a given cart or checkout.

App Installations

Method	Description
Query App Installations	Retrieves a list of up to 100 app installations, with the specified paging, filtering, and sorting.
Search App Installation	Retrieves a list of up to 100 app installations that match a free-text search expression.

Attendance

Method	Description
Count Attendances	Counts attendance records for the calling member

Attribute Definition

Method	Description
Create Attribute Definition	Creates an attribute definition.
Get Attribute Definition	Retrieves an attribute definition by its ID.
Delete Attribute Definition	Deletes an attribute definition.
Update Attribute Definition	Updates an attribute definition.
Query Attribute Definitions	Retrieves a list of up to 1000 attribute definitions, given the provided paging, filtering, and sorting.
Bulk Update Attribute Definition Tags	Adds or removes tags on multiple attribute definitions.
Bulk Update Attribute Definition Tags By Filter	Asynchronously updates tags on multiple attribute definitions that match the provided filter criteria.

Attribute Value

Method	Description
Bulk Upsert Attribute Values	Upserts attribute values for an entity.
Bulk Delete Attribute Values	Deletes the values of the given attribute definitions for an entity.
List Entity Attributes	Retrieves the entity's attribute values, each paired with its attribute definition (for the name, type, and config).
Query Attribute Values	Retrieves a list of up to 1000 attribute values, given the provided paging, filtering, and sorting.

Authentication

Method	Description
Change Password	Changes the password of a logged-in member
Sign On	Authenticates a member without credentials and returns a session token.
Logout	Terminates the member's session and clears authentication cookies.

Availability Time Slots Configuration Service Plugin

Method	Description
List Availability Time Slot Configurations	Retrieves availability time slot configurations for the specified services.

Balances

Method	Description
Get Balance Record	Retrieves a single balance record by ID for the specified account.
Query Balance Records	Retrieves a list of up to 1000 balance records, given the provided paging, filtering, and sorting.

Booking Policy Service Plugin

Method	Description
List Booking Policies	Retrieves booking policies for the specified services.

Bookings Validation Service Plugin

Method	Description
Validate Before Create	Validates whether a booking can be created.
Validate Before Cancel	Validates whether a booking can be canceled.
Validate Before Reschedule	Validates whether a booking can be rescheduled to a new time slot.
Validate Before Create Multi Service	Validates whether a multi-service booking can be created.
Validate Before Cancel Multi Service	Validates whether a multi-service booking can be canceled.
Validate Before Reschedule Multi Service	Validates whether a multi-service booking can be rescheduled.

Bookings Writer V2

Method	Description
Cancel Booking Anonymously	Cancels a booking using an anonymous token.
Reschedule Booking Anonymously	Reschedules a booking to a new slot using an anonymous token.
Get Booking Anonymously	Retrieves a booking and its allowed anonymous actions using an anonymous token.
Get Service Anonymously	Retrieves the service associated with a booking using an anonymous token.
Get Anonymous Action Token	Generates an anonymous action token for a booking.

Bulk Downloads

Method	Description
List My Bulk Downloads	Lists all bulk downloads available for the user that initiated them
Initiate Bulk Download	Initiates a bulk download process.
Get Bulk Download	Retrieves a bulk download.
Delete Bulk Download	Deletes a bulk download.

Calendar Event V1

Method	Description
Create Event	Creates a calendar event.
Query Events	Retrieves events that occur within a given date range.
Update Event	Updates a calendar event.
Delete Event	Deletes a calendar event.

Campaign V1

Method	Description
List Campaigns	Retrieves all campaigns associated with the current site.
Create Campaign	Creates a new Google Ads campaign and immediately activates it in the requested status
Update Campaign	Updates the fields of an existing campaign
Get Campaign	Retrieves a single campaign by ID.
Delete Campaign	Permanently deletes a campaign
Pause Campaign	Pauses a running campaign, stopping ad delivery immediately
Resume Campaign	Reactivates a paused campaign, resuming ad delivery.
Launch Campaign	Activates a paused campaign, changing its status to enabled and beginning ad delivery.
Get Campaign Status History	Retrieves the full status change history for a campaign in chronological order.
Get Campaign Daily Budget Boundaries	Retrieves the minimum and maximum allowed daily budget for the current account and currency.
Get Campaign Change Log	Retrieves the full change log for a campaign — all status-changing events in chronological order.

Captcha

Method	Description
Authorize	Authorizes a CAPTCHA token.

Cart V2

Method	Description
Get Current Cart	Retrieves the customer's current cart.
Create Current Cart	Creates the customer's current cart.
Delete Current Cart	Deletes the customer's current cart.
Update Current Cart	Updates the customer's current cart.
Refresh Current Cart	Re-evaluates prices, inventory, and discounts to ensure the customer's current cart is up-to-date with the latest changes.
Calculate Current Cart	Calculates the customer's current cart based on its current state (line items, discounts, delivery method, etc.) and returns a detailed summary including subtotal, delivery costs, taxes, fees, and the total price.
Estimate Current Cart	Estimates the customer's current cart totals based on its current state and the selected calculation components.
Add Line Items To Current Cart	Adds line items to the customer's current cart
Remove Line Items From Current Cart	Removes line items from the customer's current cart.
Update Line Items In Current Cart	Updates line items in the customer's current cart.
Add Coupon To Current Cart	Applies a coupon to the customer's current cart.
Remove Coupon From Current Cart	Removes a coupon from the customer's current cart.
Set Delivery Method For Current Cart	Sets the delivery method for the customer's current cart.
Remove Delivery Method From Current Cart	Removes the selected delivery method from the customer's current cart.
Add Gift Card To Current Cart	Adds a gift card to the customer's current cart.
Remove Gift Card From Current Cart	Removes a gift card from the customer's current cart.
Update Form Submissions In Current Cart	Updates form submissions associated with the customer's current cart line items.
Create Cart	Creates a cart.
Get Cart	Retrieves a cart.
Delete Cart	Deletes a cart.
Update Cart	Updates a cart.
Refresh Cart	Refreshes the cart by re-evaluating prices, inventory, and discounts so it reflects the latest catalog data.
Estimate Cart	Estimates cart totals from the cart's current state and selected calculation components.
Calculate Cart	Calculates the cart from its current state (line items, discounts, delivery method, and more) and returns a detailed summary, including subtotal, delivery costs, taxes, fees, and total price.
Get Checkout URL	Retrieves the checkout URL for the cart.
Place Order	Completes checkout and creates an order
Add Line Items	Adds line items to the cart.
Remove Line Items	Removes line items from the cart.
Update Line Items	Updates line items in the cart.
Add Coupon	Adds a coupon to the cart.
Remove Coupon	Removes a coupon from the cart.
Set Delivery Method	Sets the delivery method for the cart.
Remove Delivery Method	Removes the selected delivery method from the cart.
Add Gift Card	Adds a gift card to the cart.
Remove Gift Card	Removes a gift card from the cart.
Mark Cart As Completed	Marks the cart as completed after an order is created from it.
Update Form Submissions	Updates form submissions associated with the cart's line items.

Categories

Method	Description
Get Category By Slug	Retrieves a category by its slug.
Create Category	Creates a new category.
Get Category	Retrieves a category by ID.
Delete Category	Deletes a category.
Update Category	Updates a category.
Query Category	Retrieves a list of categories, with the specified paging, filtering, and sorting.

Compliance Review Request V1

Method	Description
Request Review	Submits a CMS compliance action on a data item for review.

Component Type Data V1

Method	Description
Get Component Types Display Data	Retrieves display metadata for the available component types.

Components Service

Method	Description
Create Component	Creates a component.
Upsert Components	Creates or updates multiple components for a single app.
Get Component	Retrieves a component by ID.
Delete Component	Deletes a component's draft version.
Update Component	Updates a component.
Get Draft App Components	Retrieves the draft version of each of an app's components.
Get Components By External Id	Retrieves an app's components that have the specified external ID.
Query Component	Retrieves a list of up to 50 components, given the provided paging, filtering, and sorting.
Get Max Version Of App Components	Retrieves the latest version number of each of an app's components.
Restore Deleted Component	Restores a deleted component.
Validate Components	Validates components for a single app.

Contact Tax Details

Method	Description
Upsert Contact Tax Details	Creates or updates a contact's tax details.
Get Contact Tax Details	Retrieves a contact's tax details by contact ID.
Delete Contact Tax Details	Deletes a contact's tax details.
Query Contact Tax Details	Retrieves a list of up to 100 contact tax details, given the provided paging, filtering, and sorting.
Bulk Upsert Contact Tax Details	Creates or updates the tax details of multiple contacts in a single request.
Bulk Delete Contact Tax Details	Deletes the tax details of multiple contacts in a single request.
Bulk Update Contact Tax Details Tags	Adds or removes tags on multiple contact tax details.
Bulk Update Contact Tax Details Tags By Filter	Asynchronously updates tags on multiple contact tax details that match the provided filter criteria.
Count Contact Tax Details	Counts the contact tax details that match the provided filter.

Containers Chat

Method	Description
Create Conversation	Creates a conversation for a project.
Get Conversation	Retrieves a conversation by its ID.
Update Conversation	Updates a conversation.
Query Conversations	Retrieves a list of up to 1,000 conversations for a project, given the provided paging, filtering, and sorting.
Send Message	Sends a user message in a conversation.
Query Messages	Retrieves a list of up to 1,000 messages in a conversation, given the provided paging and sorting.
Relay Tasks	Updates the task list on the in-flight assistant turn.
Complete Turn	Finalizes the in-flight assistant turn with the response content.
Fail Turn	Marks the in-flight assistant turn as failed.

Custom Discount Triggers Integration Service Plugin

Method	Description
List Triggers	Lists all custom triggers provided by your service plugin integration.
Get Eligible Triggers	Retrieves eligible custom discount triggers based on the provided items.

Customizations V3

Method	Description
Update Customization Choices	Updates properties of existing choices in a customization
Reorder Customization Choices	Sets the display order of a customization's choices.

Data Items

Method	Description
Async Patch Data Items By Filter	Patches all data items matching a filter
Async Remove Data Items By Filter	Removes all data items matching a filter
Get Async Job Status	Retrieves the status of an async job started by Async Patch Data Items By Filter or Async Remove Data Items By Filter.
Create Data Item Draft	Creates a draft copy of a published data item in the corresponding {dataCollectionId}__drafts shadow collection.
Publish Data Item Draft	Publishes a pending draft of a data item.
Unpublish Data Item	Retracts a published data item back to draft state.

Delivery Profiles

Method	Description
Create Delivery Profile	Creates a delivery profile.
Get Delivery Profile	Retrieves a delivery profile.
Delete Delivery Profile	Deletes a delivery profile.
Update Delivery Profile	Updates a delivery profile.
Query Delivery Profiles	Retrieves a list of up to 100 delivery profiles, given the provided paging, filtering, and sorting.
Add Delivery Region	Adds a delivery region to an existing delivery profile.
Update Delivery Region	Updates a delivery region.
Get Delivery Profile By Delivery Region Id	Retrieves a delivery profile by delivery region ID.
Remove Delivery Region	Removes a delivery region from a delivery profile.
Add Delivery Carrier	Adds a delivery carrier to a delivery region.
Remove Delivery Carrier	Removes a delivery carrier from a delivery region.
Update Delivery Carrier	Updates a delivery carrier's settings in a delivery region.
List Installed Delivery Carriers	Retrieves a list of all delivery carriers installed on a site.
Get Delivery Destination Properties	Retrieves delivery destination properties.
List Delivery Carriers	Retrieves delivery carrier settings for a delivery profile.
Set Delivery Carrier Active Status	Sets a delivery carrier's active status.
Update Extended Fields	Updates extended fields of a delivery profile without incrementing revision.

Dispute Evidence Documents

Method	Description
Create Dispute Evidence Document	Creates a dispute evidence document for a specific dispute.
Get Dispute Evidence Document	Retrieves a dispute evidence document.
Delete Dispute Evidence Document	Deletes a dispute evidence document.
Query Dispute Evidence Documents	Retrieves a list of dispute evidence documents, given the provided paging, filtering, and sorting.
Bulk Update Dispute Evidence Document Tags	Updates tags on multiple dispute evidence documents by ID.
Bulk Update Dispute Evidence Document Tags By Filter	Asynchronously updates tags on multiple dispute evidence documents based on filter criteria

Dynamic Site Context

Method	Description
Get Dynamic Context	Retrieves aggregated context for the caller's sites and account.
Get Dynamic Context Markdown	Retrieves the same aggregated context as GetDynamicContext, rendered as a markdown report

Email Subscriptions

Method	Description
Query Email Subscriptions	Retrieves email subscriptions, given the provided paging, filtering, and sorting.
Upsert Email Subscription	Updates or creates an email subscription for the requested email.
Bulk Upsert Email Subscription	Updates or creates multiple email subscriptions.
Generate Unsubscribe Link	Creates an unsubscribe link to be shared with the relevant recipient.

Email Transmission V1

Method	Description
Send Email Transmission	Creates and sends an email transmission to one or more recipients.
Get Email Transmission	Retrieves an email transmission by ID.
Delete Email Transmission	Deletes an email transmission by ID.
Query Email Transmissions	Retrieves a list of up to 100 email transmissions, given the provided paging, filtering, and sorting.

External Database Service Plugin

Method	Description
Query Data Items	Retrieves a list of items based on the provided filtering, sorting, and paging preferences.
Count Data Items	Counts the number of items in the specified data collection that match the filtering preferences.
Aggregate Data Items	Runs an aggregation query on the specified data collection and returns the resulting list of items.
Query Distinct Values	Retrieves a list of distinct values for a given field for all items that match the query, without duplicates.
Insert Data Items	Adds one or more items to a collection.
Update Data Items	Updates one or more items in a collection
Remove Data Items	Removes one or more items from a collection
Truncate Data Items	Removes all items from a collection.
Query Referenced Data Items	Retrieves the items referenced in the specified field of a referring item
Insert Data Item References	Inserts one or more item references into a referring field of the specified item.
Remove Data Item References	Removes one or more item references from a referring field of the specified item.
List Collections	Retrieves a list of data collections and their details.
Create Collection	Creates a new data collection.
Update Collection	Updates the structure of an existing data collection.
Delete Collection	Deletes a data collection.
Get Capabilities	Lists the global capabilities the external database supports.

Form Submissions Service Plugin

Method	Description
Validate Submission

Fulfillment Methods

Method	Description
List Fulfillment Methods	Retrieves a list of up to 100 fulfillment methods.
Create Fulfillment Method	Creates a new fulfillment method.
Bulk Create Fulfillment Methods	Create multiple fulfillment methods at once.
Get Fulfillment Method	Retrieves a fulfillment method.
Delete Fulfillment Method	Deletes a fulfillment method.
Update Fulfillment Method	Updates a fulfillment method.
Query Fulfillment Methods	Retrieves a list of fulfillment methods given the provided paging, filtering, and sorting
List Available Fulfillment Methods For Address	Retrieves a list of up to 100 fulfillment methods available for a given address.
Get Aggregated Method Availability	Retrieves the aggregated availability of a list of fulfillment methods.
Bulk Update Fulfillment Method Tags	Synchronously update tags on multiple fulfillment methods
Bulk Update Fulfillment Method Tags By Filter	Asynchronously update tags on multiple fulfillment methods according to the specified filter

Generated Content V1

Method	Description
Generate Text	Generates post captions from a text prompt.
Generate Image	Generates an image from a text prompt and a source image.
Get Generated Image	Retrieves the result of an asynchronous image-generation request.
Generate Post Data	Generates post content for one or more social channels.

Gift Card Products

Method	Description
Create Gift Card Product	Creates a gift card product.
Get Gift Card Product	Retrieves a gift card product.
Delete Gift Card Product	Deletes a gift card product
Update Gift Card Product	Updates a gift card product.
Query Gift Card Products	Retrieves a list of up to 1,000 gift card products, given the provided paging, filtering, and sorting.

Gift Cards Service Plugin

Method	Description
Get Balance	This method retrieves gift card data from your app
Redeem	This method requests that a transaction be created by your app
Void	This method requests that a gift card transaction be voided by your app

Google Account V1

Method	Description
Create Account	Creates a Google Ads account linked to the current Wix site
Update Account	Updates a Google Ads account linked to the current Wix site.
Delete Account	Deletes the Google Ads account and removes its link to the Wix site.
Get Account For Current Site	Retrieves the Google Ads account linked to the current Wix site
Select Incentive	Records the user's Google Ads acquisition incentive choice in the database before checkout

Google Ads App Installer V1

Method	Description
Install Google Ads If Not Installed	Installs the Wix Google Ads integration on the site if it isn't already installed.

Google Suggestion V1

Method	Description
Get Keyword Theme Suggestions	Retrieves keyword theme suggestions for a site based on its URL, language, and optional business info
Get Keyword Theme Options	Retrieves keyword theme suggestions matching a partial text query (autocomplete-style)
Get Geo Options	Retrieves geographic location suggestions matching a partial query string
Get Budget Suggestions	Retrieves three budget tiers (low, recommended, high) with estimated daily click ranges
Get Campaign Suggestions	Retrieves complete AI-generated campaign configurations
Get Text Asset Suggestions	Retrieves AI-generated text assets (headlines, descriptions) for a Performance Max campaign
Get Image Asset Suggestions	Retrieves AI-generated image assets for a Performance Max campaign using Runway AI
Get Search Theme Suggestions	Retrieves AI-generated search theme suggestions for a Performance Max campaign
Generate Budget Recommendation	Retrieves a recommended budget for PERFORMANCE_MAX or PERFORMANCE_MAX_LEADS campaigns

Intake Form V1

Method	Description
Create Intake Form	Creates an intake form.
Get Intake Form	Retrieves an intake form by ID.
Delete Intake Form	Deletes an intake form.
Update Intake Form	Updates an intake form.
Query Intake Forms	Retrieves a list of up to 100 intake forms, given the provided paging, filtering, and sorting.
Bulk Create Intake Forms	Creates multiple intake forms in a single request.
Bulk Update Intake Forms	Updates multiple intake forms in a single request.
Search Intake Forms	Searches intake forms using a free-text expression matched against the client name and project name.
Bulk Delete Intake Forms	Deletes multiple intake forms in a single request.

Item Labels

Method	Description
List Labels	Retrieves a list of up to 500 item labels.
Create Label	Creates an item label.
Get Label	Retrieves an item label by ID.
Delete Label	Deletes an item label.
Query Labels	Retrieves a list of item labels given the provided paging, filtering, and sorting
Update Label	Updates an item Label.

Item Modifier Groups

Method	Description
List Modifier Groups	Retrieves a list of up to 500 modifier groups.
Create Modifier Group	Creates a modifier group.
Get Modifier Group	Retrieves a modifier group by the ID.
Delete Modifier Group	Deletes a modifier group.
Query Modifier Groups	Retrieves a list of modifier groups given the provided paging, filtering, and sorting
Count Modifier Groups	Retrieves the number of modifier groups that match a specified filter.
Update Modifier Group	Updates a modifier group.
Bulk Create Modifier Groups	Creates multiple modifier groups.
Bulk Update Modifier Groups	Updates multiple item modifier groups at once

Item Modifiers

Method	Description
List Modifiers	Retrieves a list of up to 500 item modifiers.
Create Modifier	Creates an item modifier.
Get Modifier	Retrieves an item modifier by ID.
Delete Modifier
Update Modifier	Updates an item modifier.
Bulk Create Modifiers	Creates multiple item modifiers.
Bulk Update Modifiers	Updates multiple item modifiers at once
Query Modifiers	Retrieves a list of item modifiers given the provided paging, filtering, and sorting
Count Modifiers	Retrieves the number of modifiers that match a specified filter.
Bulk Delete Modifiers	Deletes multiple item Modifiers at once.

Item V1

Method	Description
Publish Item	Publishes an item to a connected social channel.
Publish Item By Id	Publishes a previously created item by its id.
Get Items	Retrieves a list of items by their IDs.
Create Draft Item	Creates a draft item.
Get Item	Retrieves an item by ID.
Delete Item	Deletes an item.
Query Items	Retrieves a list of items, given the provided paging, filtering, and sorting.
Cancel Scheduled Item	Cancels the scheduling of a scheduled item.
Update Item	Updates an item.
Reschedule Item	Changes the scheduled publish date of a scheduled item.
Bulk Publish Items	Publishes multiple items in a single call.

Item Variants

Method	Description
List Variants	Retrieves a list of up to 500 item variants.
Create Variant	Creates an item variant.
Get Variant	Retrieves an item variant by ID.
Delete Variant	Permanently deletes an item variant.
Update Variant	Updates an item variant.
Bulk Create Variants	Creates multiple item variants.
Bulk Update Variants	Updates multiple item variants.
Query Variants	Retrieves a list of item variants given the provided paging, filtering, and sorting
Count Variants	Retrieves the number of item variants that match a specified filter.
Bulk Delete Variants	Deletes multiple item variants at once.

Market Listing

Method	Description
Search Market Listings	Searches published market listings by keyword or app name.

Marketing Activity V1

Method	Description
Get Marketing Activity	Retrieves a marketing activity by ID.
Create Marketing Activity	Creates a marketing activity.
Query Marketing Activities	Retrieves marketing activities matching the given filter.
Update Marketing Activity	Updates a marketing activity.

Marketing Plan V1

Method	Description
Generate Marketing Plan	Generates a marketing plan for the site.
Regenerate Marketing Plan	Regenerates the upcoming activities of the existing marketing plan
Regenerate Marketing Plan With Keyword Research	Regenerates the existing marketing plan's activities and runs fresh SEO keyword research to add blog activities.
Get Social Marketing Plan	Retrieves the marketing plan's current status and its activities for the requested timeframe.
Delete Marketing Plan	Deletes the marketing plan and all its activities.
Clear Marketing Activity Posts	Removes the social post drafts from a marketing activity, leaving its story drafts unchanged.
Regenerate Marketing Activity Posts	Regenerates the social post drafts (AI image and per-channel captions) for a marketing activity, leaving its story drafts unchanged.
Regenerate Marketing Activity Posts Media	Regenerates only the image for a marketing activity's posts, leaving captions unchanged.
Update Marketing Activity Posts Media	Updates the media on a marketing activity's post drafts with the provided media URL, leaving its story drafts unchanged
Get Marketing Activity Posts	Retrieves the social post drafts and video candidates for the given marketing activities.
Generate Social Posts	Generates social post drafts (AI image and per-channel captions) for the given marketing activities.
Schedule Drafts	Schedules the given draft posts for publishing via the Publisher.
Delete Plan Marketing Activity	Deletes a marketing activity from the plan.

Marketing Settings V1

Method	Description
Get Marketing Settings	Retrieves the site's marketing settings.
Upsert Marketing Settings	Creates or updates the site's marketing settings.
Get Calendar Options	Retrieves the list of calendar options a site can select when configuring marketing settings.
Get Plan Goal Options	Retrieves the list of plan goal options a site can choose from when configuring marketing settings.
Get Point Of View Options	Retrieves the list of point-of-view options a site can choose from when configuring marketing settings.
Get Marketing Settings Defaults	Retrieves the default marketing settings applied when a site hasn't configured its own preferences

Marketplace Provider Service Plugin

Method	Description
Bulk Add Products To Store	Retrieves full product details from the marketplace provider and adds them to the site owner's Wix Stores catalog.
Bulk Generate Mockups	Generates product mockup images showing the site owner's logo or custom image on the provider's products.
Get Inventory	Retrieves current inventory levels for a product's variants.
Get Pricing Breakdown	Retrieves pricing breakdown for a product from the marketplace provider.
Get Product Mockups	Retrieves ready-made product mockup image URLs for one or more products.

Marketplace Provider Submissions

Method	Description
Submit Generated Mockups	Submits generated mockup images for one or more products.

Member Authentication

Method	Description
Send Set Password Email	Sends a site member an email with a link to set or reset their password.

Memberships Service Plugin

Method	Description
Charge Membership	This method requests that a membership be charged by your app.
Get Membership Voidability	This method retrieves from your app whether a membership can be voided.
Void Membership Charge	This method requests that a membership charge be voided by your app.

Menus

Method	Description
List Menus	Retrieves a list of up to 500 menus.
Create Menu	Creates a menu.
Bulk Create Menus	Creates multiple menus at once.
Get Menu	Retrieves a menu by ID.
Delete Menu	Deletes a menu.
Query Menus	Retrieves a list of menus given the provided paging, filtering, and sorting
Update Menu	Updates a menu.
Bulk Update Menu	Updates multiple menus at once.
Update Extended Fields	Updates only the extendedFields field.
Duplicate Menu

Messages

Method	Description
Create Message Stream	Creates a message and streams the assistant's response back in real time.
Media Attachment Upload Url	Allows site visitor to create upload url to use for uploading a file.
Bulk Get By Inbox Messages	Retrieves messages by inbox conversation ID.

Operations

Method	Description
Get Operation	Retrieves an operation.
Update Operation	Updates an operation.
Query Operation	Retrieves a list of operations, given the provided paging, filtering, and sorting.
List Operations	Retrieves a list of operations
Calculate First Available Time Slot Per Fulfillment Type	Retrieves the first available time slot of each fulfillment type for a specified operation.
Calculate First Available Time Slots Per Operation	Retrieves the first available time slot of each fulfillment type for each specified operation.
Calculate First Available Time Slots Per Menu	Retrieves the first available time slot of each fulfillment type for each specified menu.
Calculate Available Time Slots For Date	Retrieves all available time slots of each fulfillment type for the specified date.
Calculate Available Dates In Range	Retrieves all available dates of each fulfillment type within the specified time range.
Validate Operation Address	Validates an operation's address.
Bulk Update Operation Tags	Synchronously update tags on multiple operations
Bulk Update Operation Tags By Filter	Asynchronously update tags on multiple operations according to the specified filter

Order Payment Requests

Method	Description
Create Order Payment Request	Creates an order payment request.
Get Order Payment Request	Retrieves an order payment request.
Delete Order Payment Request	Deletes an order payment request.
Update Order Payment Request	Updates an order payment request.
Query Order Payment Requests	Retrieves a list of up to 1,000 order payment requests, given the provided paging, filtering, and sorting.
Get Order Payment Request URL	Retrieves the payment page URL for an order payment request.
Update Extended Fields	Updates the extended fields of an order payment request.
Void Order Payment Request	Voids the given order payment request.

Orders

Method	Description
Import Order	Imports a single order together with its historical data, such as the original creation date, order number, and statuses.
Set Order Number Counter	Sets the starting number for orders created after a migration.
Bulk Delete Imported Orders	Deletes multiple imported orders.

Orders Settings

Method	Description
Get Orders Settings	Retrieves the site's order settings.
Update Orders Settings	Updates the site's orders settings.

Partner Profile V1

Method	Description
Find Public Partner Profile By Slug	Retrieves the verified, published profile of a partner by their URL slug.
Contact Partner	Reserved for Wix first-party client UI use
Create Partner Profile	Creates a partner profile.
Delete Partner Profile	Deletes the partner profile of the currently authenticated partner
Update Partner Profile	Updates a partner profile.
Get Current Partner Profile	Retrieves the partner profile of the currently authenticated partner.

Payment Details V1

Method	Description
Get Payment Details	Retrieves billing and payment details for the current site's Google Ads account.

Payment Settings Integration Service Plugin

Method	Description
Get Payment Settings	This method retrieves payment settings from your app.

Payouts

Method	Description
List Payouts	Retrieves a paginated list of payouts for the specified Wix Payments account.
Get Payout	Retrieves a single payout by ID.

Performance Metrics V1

Method	Description
Query Search Term Metrics	Retrieves a list of search terms that triggered a Smart campaign's ads, given the provided filtering and sorting
Query Performance Metrics	Retrieves a list of daily performance metrics for a campaign, given the provided filtering and sorting
Query Conversion Metrics	Retrieves aggregated conversion metrics for a campaign from Wix Analytics
Query Shopping Performance Metrics	Retrieves a list of per-product performance metrics for a shopping or retail Performance Max campaign, given the provided filtering and sorting
Query Search Term Metrics V 2	Retrieves a list of search terms that triggered a campaign's ads, given the provided filtering and sorting
Query Asset Performance Metrics	Retrieves a list of per-asset performance metrics for a Performance Max Leads campaign, given the provided filtering and sorting

Pipelines

Method	Description
Create Pipeline	Creates a pipeline with defined stages and a final stage.
Get Pipeline	Retrieves a pipeline by ID.
Delete Pipeline	Deletes a pipeline.
Update Pipeline	Updates a pipeline.
Query Pipelines	Retrieves a list of up to 100 pipelines, given the provided paging, filtering, and sorting.
Bulk Update Pipeline Tags	Updates tags on multiple pipelines by specified pipeline IDs.
Bulk Update Pipeline Tags By Filter	Updates tags on multiple pipelines, using a filter to select which pipelines to update.

Premium Feature V1

Method	Description
Get Feature Data	Retrieves the availability and usage quota for a premium feature on the site.
Get Features Data	Retrieves the availability and usage quota for multiple premium features on the site.

Pricing Integration Service Plugin

Method	Description
Calculate Price	The Custom Pricing extension lets site owners add custom pricing to bookings on the site

Products

Method	Description
Create Product	Creates a product in the Marketplace.
Get Product	Retrieves a product by ID.
Delete Product	Deletes a product permanently from the Marketplace.
Update Product	Updates a product
Bulk Create Products	Creates multiple products in a single request.
Bulk Update Products	Updates multiple products in a single request.
Bulk Delete Products	Deletes multiple products permanently in a single request
Query Products	Retrieves a list of products with filtering, sorting, and cursor-based pagination.
Search Products	Retrieves a list of products, given the provided filtering, search expression, sorting, and cursor paging.
Bulk Update Product Tags	Updates tags on multiple products by product IDs.
Bulk Update Product Tags By Filter	Updates tags on multiple products matching a filter.
Query Categories	Queries categories using WQL - Wix Query Language.
Bulk Add Products To Store	Adds multiple Marketplace products to the caller's Wix store in a single request.

Promotions V3

Method	Description
Create Promotion	Creates a promotion.
Get Promotion	Retrieves a promotion.
Delete Promotion	Deletes a promotion.
Update Promotion	Updates a promotion.
Query Promotions	Retrieves a list of up to 100 promotions, given the provided paging, filtering, and sorting.
Bulk Create Promotions	Creates multiple promotions
Bulk Update Promotions	Updates multiple promotions
Bulk Delete Promotions	Deletes multiple promotions
Bulk Update Promotion Tags	Adds or removes tags on multiple promotions.
Bulk Update Promotion Tags By Filter	Asynchronously updates tags on multiple promotions that match the provided filter criteria.
Search Promotions	Searches promotions using WQL - Wix Query Language with support for free-text search and aggregations.
Resolve Promotions	Resolves effective promotions for a category

Provisioning V1

Method	Description
Provision Meetings App	Sets up Wix Meetings infrastructure on a site.

Refunds

Method	Description
Refund Transaction	This endpoint is used to send a merchant's refund requests to a Payment Service Provider (PSP).

Rules

Method	Description
Calculate Service Fees	Calculates service fees for an order.
List Rules	Retrieves an array of all rules.
Create Rule	Creates a rule.
Get Rule	Retrieves a rule.
Delete Rule	Deletes a rule.
Update Rule	Updates a rule.
Query Rules	Retrieves a list of rules, given the provided paging, filtering, and sorting.
Bulk Create Rules	Bulk creates rules.
Bulk Update Rules	Bulk updates rules.
Bulk Delete Rules	Bulk deletes rules.
Bulk Update Rule Tags	Synchronously update tags on multiple rules
Bulk Update Rule Tags By Filter	Asynchronously update tags on multiple rules according to the specified filter

Sections

Method	Description
Duplicate Section	Duplicates a section.
List Sections	Retrieves a list of up to 500 sections.
Create Section	Creates a section.
Bulk Create Sections	Creates multiple sections at once.
Get Section	Retrieves a section by ID.
Delete Section	Deletes a section.
Query Sections	Retrieves a list of sections given the provided paging, filtering, and sorting
Update Section	Updates a section.
Bulk Update Section	Updates multiple sections at once.
Bulk Delete Sections	Deletes multiple sections at once.

Semantic Search

Method	Description
Search Documents	Searches Wix documentation entries by a search term and document type.
Search Documents Markdown	Searches Wix documentation and returns results as a single markdown string ready to be passed directly to an LLM.

Site Payment Method Types

Method	Description
Get Site Payment Method Type	Retrieves a payment method type, with some fields localized according to the caller's language and country.
List Site Payment Method Types	Retrieves a list of payment method types.

Staff Member Settings

Method	Description
Get Staff Member Settings	Retrieves the current privacy settings for staff member contact information.
Update Staff Member Settings	Updates privacy settings for staff member contact information.

Staff Sorting Service Plugin

Method	Description
Sort Staff Members	Sorts staff members using custom business logic for assigning resources to a booking.

Statistics V2

Method	Description
Get Statistics	Retrieves aggregated AI Site-Chat statistics for the authenticated site.

Storage Item

Method	Description
Create Storage Item	Creates a storage item.
Get Storage Item	Retrieves the specified storage item.
Update Storage Item Value	Updates the value of an existing storage item.
Update Storage Item Counter By	Atomically increments or decrements a storage item of type COUNTER by the specified value.
Query Storage Items	Retrieves a list of storage items based on the filtering, sorting, and paging preferences you provide.
Bulk Update Storage Item Tags	Updates tags for the specified storage items.
Bulk Update Storage Item Tags By Filter	Updates tags for storage items that match the specified filter criteria

Suppliers

Method	Description
Create Supplier	Creates a supplier profile.
Get Supplier	Retrieves a supplier by ID, returning complete supplier information including current revision number for update operations.
Delete Supplier	Permanently deletes a supplier from the marketplace
Update Supplier	Updates a supplier.
Query Suppliers	Retrieves a list of suppliers with filtering, sorting, and cursor-based pagination.
Bulk Create Suppliers	Creates multiple suppliers in a single synchronous request.
Bulk Update Suppliers	Updates multiple suppliers in a single synchronous request.
Bulk Delete Suppliers	Permanently deletes multiple suppliers in a single synchronous request
Bulk Update Supplier Tags	Updates tags on multiple suppliers specified by supplier IDs in a single synchronous request.
Bulk Update Supplier Tags By Filter	Updates tags on multiple suppliers matching filter criteria in a single asynchronous request.

Tax Documents

Method	Description
Get Tax Document	Retrieves a tax document by ID.
List Tax Documents	Retrieves a list of tax documents that belong to a Wix Payments account.
Generate File Download Info	Generates temporary information for downloading a tax document's file.

Tax Exempt Groups

Method	Description
Create Tax Exempt Group	Creates a tax exempt group.
Get Tax Exempt Group	Retrieves a tax exempt group.
Delete Tax Exempt Group	Deletes a tax exempt group.
Update Tax Exempt Group	Updates a tax exempt group.
Query Tax Exempt Groups	Retrieves a list of up to 100 tax exempt groups, given the provided paging, filtering, and sorting.
Bulk Create Tax Exempt Groups	Creates multiple tax exempt groups in a single request.
Bulk Update Tax Exempt Groups	Updates multiple tax exempt groups in a single request.
Bulk Delete Tax Exempt Groups	Deletes multiple tax exempt groups in a single request.
Bulk Update Tax Exempt Group Tags	Adds or removes tags on multiple tax exempt groups.
Bulk Update Tax Exempt Group Tags By Filter	Asynchronously updates tags on multiple tax exempt groups that match the provided filter criteria.
List Default Tax Exempt Groups	Retrieves the site's default tax exempt groups.

Tax Settings

Method	Description
Get Tax Settings	Retrieves the site's tax settings.
Upsert Tax Settings	Creates or updates the site's tax settings.

Template V1

Method	Description
Copy Site As Template	Creates a template by duplicating an existing site.
Create Site From Template	Creates a site from a template.
Publish Template	Publishes a template, turning it into a public template.
Get Template	Retrieves a template by ID.
Delete Template	Deletes a template.
Update Template	Updates a template.
Count Templates	Counts the templates that match the provided filter.
Query Templates	Retrieves a list of templates, given the provided paging, filtering, and sorting.

Time Slots V2

Method	Description
List Availability Time Slot End Options	Retrieves the available end times for a selected start time of an appointment-based service configured with a duration range.

Transactions

Method	Description
Create Transaction	This endpoint is used to send a merchant's payment requests to a Payment Service Provider (PSP).
Capture Transaction	This endpoint is used to send requests to capture transactions to a Payment Service Provider (PSP).
Void Transaction	This endpoint is used to send requests to void transactions to a Payment Service Provider (PSP).
Query Gift Card Transactions	Retrieves the transaction history for a specific gift card with filtering, sorting, and paging options.

Translation Content

Method	Description
Get Content Word Count	Gets word counts and field counts for translatable content across a site.

Trigger Catalog

Method	Description
Create Trigger	Creates a trigger for the specified app
Get Trigger	Retrieves a trigger by ID (changes per component version)
Update Trigger	Updates the specified trigger for the specified app.
Delete Trigger By App Id And Key	Deletes a trigger from the specified app.
Query Triggers	Retrieves a list of triggers, given the provided paging, filtering, and sorting.
Get Trigger Dynamic Schema	Retrieves a trigger's payload schema with the user's filter field selections applied.
Get Identities Schema	Retrieves the schema of the identity types that triggers can reference.

Triggered Events

Method	Description
Run Automation	Runs an automation directly, without reporting an event.
Test Automation	Runs an automation in test mode, without reporting an event.
Rerun Activation	Reruns a previous activation, reusing its original payload and external entity ID.
Report Action Invocation Completed	Reports to Wix that your action has completed.

User Certification V1

Method	Description
Get User Certification	Retrieves a user certification.

Waitlist

Method	Description
List Waitlisted Entities	Returns a list of waitlisted entries
Register To Waitlist	Registers a site member to a waitlist
Leave Waitlist	Removes a site member's registration to a waitlist (and cancels the associated pending-state booking)
Book From Waitlist	Books a site member into the session for which they are waitlisted (waiting resource), and the associated booking is checked out

Wix Payments Account

Method	Description
Connect Wix Payments Account	Connects a Wix Payments account to the site.