---
updatedAt: 2026-11-11T07:32:40.000Z
agentTools:
  projectIndex: https://docs.yotpo.com/llms.txt
---

# Add metadata to an existing review

Use this endpoint to add metadata to an existing review. The `review_id` can be retrieved using the [Retrieve all reviews](ref:retrieve-all-reviews) endpoint.

> 👍 How to use this endpoint
>
> * Requests for this endpoint are limited to 5,000 requests/minute, per app key.
> * Review-related metadata takes 6 hours to appear in Yotpo Reviews and on-site.
> * To see example requests, click **Examples** in the payload on the right.
> * For example responses, click the relevant status code on the right.
> * Metadata keys must use lowercase only.

## Metadata that can be updated:

* `color`
* `size`
* `country`
* `custom_properties`

## Metadata that cannot be updated:

* `domain_key`
* `name`
* `url`
* `image`
* `description`
* `tags`
* `specs`
* `date`
* `platform`
* `user_reference`

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Reviews API (V1)",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.yotpo.com",
      "description": "Main API server for authenticated and write operations"
    }
  ],
  "components": {
    "securitySchemes": {
      "X-Yotpo-Token": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Yotpo-Token",
        "description": "Your Yotpo account access token. See [Yotpo Authentication](ref:yotpo-authentication) to learn how to generate your token."
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Missing or invalid access token",
        "content": {
          "application/json": {
            "examples": {
              "Unauthorized": {
                "value": {
                  "status": {
                    "message": "You are not authorized to access this page.",
                    "code": 401,
                    "error_type": "Exceptions::AccessDenied"
                  }
                }
              }
            },
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "description": "Human-readable error message"
                    },
                    "code": {
                      "type": "integer",
                      "description": "HTTP status code"
                    },
                    "error_type": {
                      "type": "string",
                      "description": "Internal error class"
                    }
                  },
                  "description": "Error details."
                }
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "X-Yotpo-Token": []
    }
  ],
  "paths": {
    "/v1/apps/{store_id}/reviews/{review_id}/metadata": {
      "post": {
        "summary": "Add metadata to an existing review",
        "description": "Use this endpoint to add metadata to an existing review. The `review_id` can be retrieved using the [Retrieve all reviews](ref:retrieve-all-reviews) endpoint.",
        "operationId": "add-metadata-to-an-existing-review",
        "parameters": [
          {
            "name": "store_id",
            "in": "path",
            "description": "The store ID",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "review_id",
            "in": "path",
            "description": "The unique review identifier",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "customer": {
                    "properties": {
                      "email": {
                        "type": "string",
                        "description": "The customer's email address"
                      },
                      "state": {
                        "type": "string",
                        "description": "The state the customer is located in"
                      },
                      "country": {
                        "type": "string",
                        "description": "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_properties": {
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "The name of the customer-related custom property"
                          },
                          "value": {
                            "type": "string",
                            "description": "The value of the customer-related custom property"
                          }
                        },
                        "required": [],
                        "type": "object",
                        "description": "Custom name/value property."
                      }
                    },
                    "required": [],
                    "type": "object",
                    "description": "Customer details to attach to the review."
                  },
                  "order": {
                    "properties": {
                      "coupon_used": {
                        "type": "boolean",
                        "description": "Indicate whether a coupon was applied to this purchase"
                      },
                      "delivery_type": {
                        "type": "string",
                        "description": "The type of shipping/delivery used"
                      },
                      "custom_properties": {
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "The name of the order-related custom property"
                          },
                          "value": {
                            "type": "string",
                            "description": "The value of the order-related custom property"
                          }
                        },
                        "required": [],
                        "type": "object",
                        "description": "Custom name/value property."
                      }
                    },
                    "required": [],
                    "type": "object",
                    "description": "Order details to attach to the review."
                  },
                  "products": {
                    "properties": {
                      "color": {
                        "type": "string",
                        "description": "The color of the product"
                      },
                      "size": {
                        "type": "string",
                        "description": "The size of the product"
                      },
                      "material": {
                        "type": "string",
                        "description": "The material the product is made of"
                      },
                      "vendor": {
                        "type": "string",
                        "description": "The product vendor"
                      },
                      "model": {
                        "type": "string",
                        "description": "The product model"
                      },
                      "coupon_used": {
                        "type": "boolean",
                        "description": "Whether a coupon was applied to this purchase of this product"
                      },
                      "custom_properties": {
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "The name of the product-related custom property"
                          },
                          "value": {
                            "type": "string",
                            "description": "The value associated with the product-related custom property. This should be written as you want it to display on your site."
                          }
                        },
                        "required": [],
                        "type": "object",
                        "description": "Custom name/value property."
                      }
                    },
                    "required": [],
                    "type": "object",
                    "description": "Product details to attach to the review."
                  }
                },
                "required": []
              },
              "examples": {
                "JSON": {
                  "value": {
                    "customer": {
                      "email": "thomas@example.com",
                      "state": "California",
                      "country": "US",
                      "custom_properties": [
                        {
                          "name": "membership_type",
                          "value": "premium"
                        }
                      ]
                    },
                    "order": {
                      "coupon_used": "true",
                      "delivery_type": "standard",
                      "custom_properties": [
                        {
                          "name": "order_history",
                          "value": "5"
                        }
                      ]
                    },
                    "product": {
                      "color": "black",
                      "size": "large",
                      "material": "cotton",
                      "vendor": "uniqlo",
                      "model": "hoodie",
                      "coupon_used": "true",
                      "custom_properties": [
                        {
                          "name": "event_type",
                          "value": "Black Friday"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": {\n        \"code\": \"ok\",\n        \"message\": \"ok\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "object",
                      "properties": {
                        "code": {
                          "type": "string",
                          "example": "ok",
                          "description": "Status code."
                        },
                        "message": {
                          "type": "string",
                          "example": "ok",
                          "description": "Status message, for example `ok`."
                        }
                      },
                      "description": "Request status."
                    }
                  }
                }
              }
            },
            "headers": {
              "ratelimit-limit": {
                "description": "The maximum number of requests allowed in the current time window",
                "schema": {
                  "type": "integer"
                }
              },
              "ratelimit-remaining": {
                "description": "The number of requests remaining in the current time window",
                "schema": {
                  "type": "integer"
                }
              },
              "ratelimit-reset": {
                "description": "The time (in seconds) until the rate limit resets",
                "schema": {
                  "type": "integer"
                }
              },
              "x-ratelimit-limit-minute": {
                "description": "The maximum number of requests allowed per minute",
                "schema": {
                  "type": "integer"
                }
              },
              "x-ratelimit-remaining-minute": {
                "description": "The number of requests remaining in the current minute",
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            },
            "headers": {
              "ratelimit-limit": {
                "description": "The maximum number of requests allowed in the current time window",
                "schema": {
                  "type": "integer"
                }
              },
              "ratelimit-remaining": {
                "description": "The number of requests remaining in the current time window",
                "schema": {
                  "type": "integer"
                }
              },
              "ratelimit-reset": {
                "description": "The time (in seconds) until the rate limit resets",
                "schema": {
                  "type": "integer"
                }
              },
              "x-ratelimit-limit-minute": {
                "description": "The maximum number of requests allowed per minute",
                "schema": {
                  "type": "integer"
                }
              },
              "x-ratelimit-remaining-minute": {
                "description": "The number of requests remaining in the current minute",
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "value": "application/json",
        "key": "Content-Type"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```