bulkCancelReviewRequestsByFilter( )

Developer Preview

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

Cancels review requests given specified filters.

When this method is used, a bulk job is started and the job ID is returned. The job might not complete right away, depending on its size. The job's status can be retrieved with getAsyncJob() or listAsyncJobItems().

For a list of supported filters, see the table in queryReviewRequests.

To check which review requests will be canceled with this filter, you can run the filter with queryReviewRequests() and confirm which review requests are returned with that filter.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Review Requests
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsBulkCancelReviewRequestsByFilterOptions
Returns
Return Type:Promise<BulkCancelReviewRequestsByFilterResponse>
JavaScript
Errors

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

Did this help?