PUT

Bulk Cancel Review Requests 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.

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 Get Async Job or List Async Job Items.

For field support for filters and sorting, see Review Requests: Supported Filters and Sorting.

To check which review requests will be canceled with this filter, you can run the filter with Query Review Requests and confirm which review requests are returned with that filter.

Authentication

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

Permissions
Manage Review Requests
Learn more about app permissions.
Endpoint
PUT
https://www.wixapis.com/reviews/v2/bulk/review-requests/cancel-by-filter

Body Params
filterstruct

Filter object in the following format: "filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }

Response Object
jobIdstringformat GUID

Bulk job ID. The job's status can be retrieved with Get Bulk Job or List Bulk Jobs.

Bulk Cancel Review Requests By Filter
Request
cURL
Response
JSON
Errors

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

Event TriggersThis method triggers the following events:
Did this help?