Update product review status

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

Request and response example

Request:

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

{
  "status": "moderated"
}

Response:

{
  "updateCount": 1
}

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.

reviewId

number

Internal review 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:

Header
Format
Description

status

string

New review status. One of:

moderated - Review is not yet published by the store owner.

published - Review is published by the store owner. Required

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?