younifyd
Menu

Update Existing Review Metadata

Update existing review metadata

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

Use it in a workflow

  1. Add a step and choose the Yotpo connector.
  2. Pick the Update Existing Review Metadata action (under Reviews & Ratings).
  3. Fill in the fields below, then reference the result from later steps as {{updateExistingReviewMetadata.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. Default value:`US` [See country codes list](https://datahub.io/core/country-list)

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 {{updateExistingReviewMetadata.response.data.<field>}}.

statusobject
codeinteger

Default 0

messagestring
responseobject
app_keystring
payloadobject1 fields
json
{
  "status": {
    "code": 200,
    "message": "ok"
  },
  "response": {
    "app_key": "FCyPO8c4Z9W0pBOQan2RPoxOO8rFhyXOFnRA2xGA",
    "payload": {
      "customer": {
        "email": "customer@email.com"
      }
    }
  }
}

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