Sign in

v1

latestOpenAPI 3.1.12026-07-222968170.1 KB
reviews

post/v2/reviews/{platform}

Path parameters

platformstring required
Example:custom

The review platform. Use your platform identifier if you are a review partner, or "custom" if you are a merchant integrating a custom reviews app

Query parameters

site_idnumber

Create the review in the specified site. This is only required for programs that have multiple sites. Programs with only a single site can omit this parameter, and the review will be created in the program's only site

Request body

merchant_idstring required

The ID of the review in your review platform

status'approved' | 'flagged' | 'pending' | 'rejected' required

The current status of the review, which determines how and when associated rules are triggered. One of: pending (the review is pending review), flagged (the review has been flagged for review), approved (the review has been approved/published), rejected (the review has been rejected)

full_textstring required

The full text of the review

ratingnumber required

The rating given in the review

images_countnumber required

The number of images attached to the review

videos_countnumber required

The number of videos attached to the review

datestring required

The date this review was created in the review platform, as an ISO 8601 timestamp

product_merchant_idstring nullable

If this review was for a specific product, this should be set to the product ID in your ecommerce platform. If you are a review partner, this must be the ID of the product in the connected store, e.g. a Shopify product ID

moderation_urlstring uri nullable

Optional URL to moderate the review in the review platform

Example request

{
  "date": "2026-01-01T12:00:00Z"
}

Response

201

Example response

{
  "review": {
    "platform": "custom",
    "full_text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit",
    "rating": 5,
    "images_count": 3
  }
}