Pick the Create Review action (under Reviews & Ratings).
Fill in the fields below, then reference the result from later steps as {{createReview.response.data}}.
Request
Request body
Enter the body as JSON in the step's Body field.
appkeystringrequired
The store ID
domainstring
The account domain
skustringrequired
The unique ID of the product on your site (doesn't have to be the SKU). To create a site review, use the value: `yotpo_site_reviews`. This parameter supports alphanumeric (a...z, A...Z, 0...9), "_" and "-" characters.
product_titlestringrequired
The title of the product
product_descriptionstring
The description of the product
product_urlstringrequired
The url of the product where the reviews are displayed
product_image_urlstring
The url of the product image
display_namestringrequired
The reviewer's name
emailstringrequired
The email of the reviewer
is_incentivizedboolean
Indicates if the review comes from an incentivized source (for example, a product sampling company)
incentive_typestring
The type of incentive provided for the review
One offree_productcouponloyalty_pointspaid_promotionemployee_reviewother
review_contentstringrequired
The content of the review
review_titlestringrequired
The title of the review
review_scoreinteger (int32)required
The review score
signaturestring
Relevant only for customers using the Trusted Vendors feature. The signature is the hexadecimal representation of a computed Hash-based Message Authentication Code, using SHA256 as the cryptographic function (HMAC-SHA256). The secret for the function is the account secret. Note: The `time_stamp` and `reviewer_type` parameters are mandatory when using the signature parameter.
time_stampstring (date-time)
Required for customers using the Trusted Vendors feature. Unix timestamp.
submission_time_stampstring (date-time)
Relevant only for customers using the Trusted Vendors feature. The date the review was created (if not today). Can be up to 7 days in the past. If you want to add a creation date that is more than 7 days in the past, please contact support
reviewer_typestring
Required for customers using the Trusted Vendors feature. Possible values: `verified_buyer` or `verified_reviewer`
delivery_typestring
The type of delivery designated for this purchase e.g. express, expedited, standard
order_metadataobject
coupon_usedboolean
Part of `order_metadata`, indicates whether a coupon was used at purchase
valuestring
The order-related `custom_properties` value
namestring
The name of an order-related custom property e.g. order history
product_metadataobject
colorstring
The color of the item
sizestring
The size of the item
materialstring
The material the product is made of
modelstring
The model name of the product
vendorstring
The product vendor
coupon_usedboolean
Whether a coupon was used for this product
custom_propertiesobject2 fields
customer_metadataobject
statestring
The state the customer is located in
countrystring
Two-letter uppercase country code indicating the customer country. To comply with Google Seller Ratings conventions, the country code value must be from [this list](https://datahub.io/core/country-list) of compatible codes. Default value: `US`.
