POST

Async Patch Data Items By Filter


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Patches all data items matching a filter. Runs asynchronously.

This method selects all items that match the specified filter and applies the given field modifications to each one. Unlike Bulk Patch Data Items, you don't need to specify individual item IDs. Instead, items are selected by filter.

The operation runs asynchronously and returns a job ID for tracking status. Call Get Async Job Status with the returned job ID to poll for status.

An empty filter patches all items in the collection.

Notes:

  • The number of affected items is not bounded.
  • If any item fails to be patched, the async job stops and its status becomes FAILED. Some items may already have been patched before the failure.
  • Each patched item's data._updatedDate property is updated to the current date and time.
  • Calling this method triggers the Data Item Updated event for each patched item.
  • Job records are retained for 30 days. After that, querying the job ID returns NOT_FOUND.
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Write Data Items
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/wix-data/v2/bulk/items/async-patch-by-filter

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?