Create review (synchronous)

post

https://api.yotpo.com/reviews/dynamic_create

Note: This method is recommended for development only.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

👍
How to use this endpoint

To see example requests, click Examples in the payload on the right.

Requests for this endpoint are limited to 5,000 requests/minute, per app key.

Data is retrieved in real-time.

📘
Please note:

The following parameters are relevant only for customers using the Trusted Vendors feature: signature, time_stamp, submission_time_stamp, and reviewer_type.

If you're using this feature, please make sure you refer to our dedicated help center article before you use this endpoint. To learn more, please contact your Yotpo representative.

Custom questions

Click the Create Review + Custom Questions tab to view a sample response of a review with custom question fields. Contact your Yotpo Customer Success Manager if you need help identifying the custom_field slug.

e.g.
custom_fields": {
"--12159": ["Chilly days","Rainy mornings","Windy evenings"],
"--12014": "123"}

Note that custom fields should carry values that are in line with the type of question being asked. For example, a rating question type would carry numerical values e.g. 1-5 while a textual question type would carry values such as "good" "okay" and "poor".

Body Params

appkey

string

required

The store ID

domain

string

The account domain

sku

string

required

The ID of the product on your site. This parameter supports alphanumeric (a...z, A...Z, 0...9), "_" and "-" characters.

product_title

string

required

The title of the product

product_description

string

The description of the product

product_url

string

The url of the product on your ecommerce site

product_image_url

string

The url of the product image

display_name

string

required

The name of the reviewer

string

required

The email of the reviewer

is_incentivized

boolean

Indicates if the review comes from an incentivized source (for example, a product sampling company)

review_content

string

required

The content of the review

review_title

string

required

The title of the review

review_score

string

required

The review score

signature

string

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.

time_stamp

string

Required for customers using the Trusted Vendors feature. Unix timestamp.

submission_time_stamp

string

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_type

string

Required for customers using the Trusted Vendors feature. Possible values: verified_buyer or verified_reviewer

delivery_type

string

The type of delivery designated for this purchase e.g. express, expedited, standard

user_reference

string

External user id, can be used later on to retrieve reviews associated with this user

image_urls

array of strings

The URLs of images associated with the review. You can upload up to 5 images per review.

image_urls

order_metadata

object

product_metadata

object

customer_metadata

object

Responses

How to use this endpoint

Please note:

Custom questions

200200

400400