Creating Reviews

Creating Reviews (without metadata)

POST/v1/widget/reviews/#####REMOVE#THIS#PART######

Use it in a workflow

Add a step and choose the Yotpo connector.
Pick the Creating Reviews action (under Reviews & Ratings).
Fill in the fields below, then reference the result from later steps as {{creatingReviews.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

appkeystringrequired

Your Yotpo account API key

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`

product_titlestringrequired

The title of the product

product_descriptionstring

The description of the product

product_urlstringrequired

The url of the product

product_image_urlstring

The url of the product image

display_namestringrequired

The reviewer's name

emailstringrequired

The email of the reviewer

review_contentstringrequired

The content of the review

review_titlestringrequired

The title of the review

review_scoreinteger (int32)required

The review score

signaturestring

Relevant only when 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)

Unix timestamp

reviewer_typestring

The reviewer type. Possible values: `verified_buyer` or `verified_reviewer` Note: This is relevant when creating reviews as a Trusted Vendor (signature is mandatory)

json

{
  "appkey": "string",
  "sku": "string",
  "product_title": "string",
  "product_url": "string",
  "display_name": "string",
  "email": "string",
  "review_content": "string",
  "review_title": "string",
  "review_score": 0,
  "domain": "string",
  "product_description": "string",
  "product_image_url": "string"
}

Response

Returns 200 with an object. Read it in later steps with {{creatingReviews.response.data.<field>}}.

codeinteger

Default 0

messagestring

image_upload_tokenstring

json

{
  "code": 200,
  "message": "ok",
  "image_upload_token": "08733ce2540436bfe12ee87e5b26d7feffe22298"
}

Need more? See the Yotpo guide for connection setup and behaviour shared by every action.

Was this page helpful?