YOyotpo

Publish/Unpublish Reviews

Changed on

This API allows you to publish or reject one or multiple reviews to the onsite widgets.

post/v2/{store_id}/moderation/reviews

Request

  • Base URL
    https://developers.yotpo.com
  • URL
    https://developers.yotpo.com/v2/{store_id}/moderation/reviews
  • Auth
    API key in header X-Yotpo-Token

Path parameters

store_idstring required

Store id/app key of the merchant

Request body

review_actionstring required

The action to perform on the reviews. Allowed values: "publish", "unpublish"

review_idsinteger[] required

An array of review IDs to be published or unpublished.

admin_emailstring

The email address of the admin initiating the action. It will be visible in moderation audit log

admin_display_namestring

The display name of the admin initiating the action. It will be visible in moderation audit log

reasonstring

Reason of unpublish review_action. Needed for unpublish review_action

Response

204

Changes