Add Metadata To An Existing Review

Add metadata to an existing review

POST/v1/apps/{app_key}/reviews/{review_id}/metadata?utoken=utoken

Use it in a workflow

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

Request

Path parameters

app_keystringrequired

The store ID

review_idstringrequired

The unique review identifier

Query parameters

utokenstringrequired

Your Yotpo account access token. See [Yotpo Authentication](https://apidocs.yotpo.com/reference#yotpo-authentication) to learn how to generate your utoken.

Request body

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

customerobject

emailstring

The customer's email address

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`.

custom_propertiesobject2 fields

orderobject

coupon_usedboolean

Indicate whether a coupon was applied to this purchase

delivery_typestring

The type of shipping/delivery used

custom_propertiesobject2 fields

productsobject

colorstring

The color of the product

sizestring

The size of the product

materialstring

The material the product is made of

vendorstring

The product vendor

modelstring

The product model

coupon_usedboolean

Whether a coupon was applied to this purchase of this product

custom_propertiesobject2 fields

json

{
  "customer": {
    "email": "string",
    "state": "string",
    "country": "string",
    "custom_properties": {
      "name": "string",
      "value": "string"
    }
  },
  "order": {
    "coupon_used": false,
    "delivery_type": "string",
    "custom_properties": {
      "name": "string",
      "value": "string"
    }
  },
  "products": {
    "color": "string",
    "size": "string",
    "material": "string",
    "vendor": "string",
    "model": "string",
    "coupon_used": false,
    "custom_properties": {
      "name": "string",
      "value": "string"
    }
  }
}

Response

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

statusobject

codestring

messagestring

json

{
  "status": {
    "code": "ok",
    "message": "ok"
  }
}

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

Was this page helpful?