Bulk update/delete product reviews

PUT https://app.ecwid.com/api/v3/{storeId}/reviews/mass_update

Request and response example

Request:

PUT /api/v3/1003/reviews/mass_update HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com
Content-Type: application/json
Cache-Control: no-cache

{
  "selectMode": "ALL",
  "delete": false,
  "newStatus": "published"
}

Response:

{
  "updateCount": 2
}

Required access scopes

Your app must have the following access scopes to make this request: update_reviews

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

Headers

The Authorization header is required.

Header
Format
Description

Authorization

Bearer secret_ab***cd

Access token of the application.

Request JSON

A JSON object with the following fields:

Field
Type
Description

selectMode

string

Filtering behavior for finding product reviews to update/delete.

One of:

  • SELECTED - Request only updates the product reviews whose IDs are specified in the reviewIds array.

  • ALL_FILTERED - Request updates the product reviews matching criteria in the currentFilters object.

  • ALL - Request updates all reviews in the store without any filtering.

Required

delete

boolean

Working mode for the request. It can either delete product reviews from the store or update their status (published/unpublished).

One of:

  • true - Request deletes product reviews.

  • false - Request updates product reviews' status.

Defaut value is false.

newStatus

string

Set new review status. One of:

  • MODERATED - Product reviews become unpublished. Such reviews are not visible on the storefront.

  • PUBLISHED - Product reviews become. Such reviews are visible on the storefront.

Requires "delete": false.

Case sensitive

reviewIds

array of numbers

Specify the list of review IDs for the update as an array. Requires "selectMode": "SELECTED". Otherwise, request ingores this field.

currentFilters

Specify search criteria to find product reviews for the update. Requires "selectMode": "ALL_FILTERED". Otherwise, request ingores this field.

currentFilters

Field
Type
Description

reviewId

array of numbers

Find reviews by their IDs.

For example, [76259972, 97266752].

productId

array of numbers

Find reviews by product IDs.

For example, [689454040, 692730761].

orderId

array of numbers

Find reviews by their assigned order IDs. Requires internal order IDs.

For example, [82163452, 144937920].

rating

array of numbers

Find product reviews by their rating from 1 to 5. Supports multiple rating values. For example, [1, 2, 3].

status

string

Search reviews by their status. One of:

  • MODERATED - Find unpublished product reviews invisible on the storefront.

  • PUBLISHED - Find published product reviews visible on the storefront.

Case sensitive

searchKeyword

string

Find product reviews by searching specific words in the review text left by customers.

createdFrom

string

Find reviews by their creation time (upper bound). For example, 1744013600

createdTo

string

ind reviews by their creation time (lower bound). For example, 1742110000

Response JSON

A JSON object with the following fields:

Field
Type
Description

updateCount

number

The number of updated items that defines if the request was successful. One of:

1 if the item was updated,

0 if the item was not updated.

Last updated

Was this helpful?