> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# BulkCancelReviewRequestsByFilter

# Package: reviews

# Namespace: ReviewRequestsV2

# Method link: https://dev.wix.com/docs/api-reference/crm/community/feedback-moderation/reviews/review-requests/bulk-cancel-review-requests-by-filter.md

## Permission Scopes:
Manage Review Requests: SCOPE.DC_REVIEWS.MANAGE-REVIEW_REQUESTS

## Introduction

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](https://dev.wix.com/docs/rest/business-management/async-job/get-async-job.md)
or [List Async Job Items](https://dev.wix.com/docs/rest/business-management/async-job/list-async-job-items.md).

See [Query Review Requests](https://dev.wix.com/docs/rest/crm/community/reviews/review-requests/query-review-requests.md) for a list of supported filters.

To check which review requests will be canceled with this filter, you can run the filter with
[Query Review Requests](https://dev.wix.com/docs/rest/crm/community/reviews/review-requests/query-review-requests.md)
and confirm which review requests are returned with that filter.

---

## REST API

### Schema

```
 Method: bulkCancelReviewRequestsByFilter
 Description: Cancels review requests given specified filters.  When this method is used, a bulk job is started and the job GUID is returned. The job might not complete right away, depending on its size. The job's status can be retrieved with [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/get-async-job.md) or [List Async Job Items](https://dev.wix.com/docs/rest/business-management/async-job/list-async-job-items.md).  See [Query Review Requests](https://dev.wix.com/docs/rest/crm/community/reviews/review-requests/query-review-requests.md) for a list of supported filters.  To check which review requests will be canceled with this filter, you can run the filter with [Query Review Requests](https://dev.wix.com/docs/rest/crm/community/reviews/review-requests/query-review-requests.md) and confirm which review requests are returned with that filter.
 URL: https://www.wixapis.com/reviews/v2/bulk/review-requests/cancel-by-filter
 Method: PUT
 Method parameters:
   param name: filter | type: filter | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` 
 Return type: BulkCancelReviewRequestsByFilterResponse
  - name: jobId | type: string | description: Bulk job GUID. The job's status can be retrieved with Get Bulk Job or List Bulk Jobs. 


```

### Examples

### Bulk Cancel Review Requests By Filter
```curl
curl -X POST \
  'https://www.wixapis.com/reviews/v2/review-requests/cancel-by-filter'  \
  -H 'Content-Type: application/json;charset=UTF-8' \
  -H 'Authorization: <AUTH>' \
  -d '{
        "filter":
        {
          "namespace": "stores"
        }
      }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.reviews.ReviewRequestsV2.bulkCancelReviewRequestsByFilter(options)
 Description: Cancels review requests given specified filters.  When this method is used, a bulk job is started and the job GUID is returned. The job might not complete right away, depending on its size. The job's status can be retrieved with [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/get-async-job.md) or [List Async Job Items](https://dev.wix.com/docs/rest/business-management/async-job/list-async-job-items.md).  See [Query Review Requests](https://dev.wix.com/docs/rest/crm/community/reviews/review-requests/query-review-requests.md) for a list of supported filters.  To check which review requests will be canceled with this filter, you can run the filter with [Query Review Requests](https://dev.wix.com/docs/rest/crm/community/reviews/review-requests/query-review-requests.md) and confirm which review requests are returned with that filter.
 Method parameters:
   param name: options | type: BulkCancelReviewRequestsByFilterOptions  none 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` 
 Return type: PROMISE<BulkCancelReviewRequestsByFilterResponse>
  - name: jobId | type: string | description: Bulk job GUID. The job's status can be retrieved with Get Bulk Job or List Bulk Jobs. 


```

### Examples

### bulkCancelReviewRequestsByFilter
```javascript
import { reviewRequests } from '@wix/reviews';

async function bulkCancelReviewRequestsByFilter(options) {
  const response = await reviewRequests.bulkCancelReviewRequestsByFilter(options);
};
```

### bulkCancelReviewRequestsByFilter (with elevated permissions)
```javascript
import { reviewRequests } from '@wix/reviews';
import { auth } from '@wix/essentials';

async function myBulkCancelReviewRequestsByFilterMethod(options) {
  const elevatedBulkCancelReviewRequestsByFilter = auth.elevate(reviewRequests.bulkCancelReviewRequestsByFilter);
  const response = await elevatedBulkCancelReviewRequestsByFilter(options);
}
```

### bulkCancelReviewRequestsByFilter (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { reviewRequests } from '@wix/reviews';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { reviewRequests },
  // Include the auth strategy and host as relevant
});


async function bulkCancelReviewRequestsByFilter(options) {
  const response = await myWixClient.reviewRequests.bulkCancelReviewRequestsByFilter(options);
};
```

---