Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/review_widget/editBeta

Edit Review Widget

This endpoint is marked Beta. It is live, but its request or response shape may still change.
Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Content-Typestringrequired

Body

NameTypeRequiredDescription
widgetIdstringrequired
minimumRatingintegerrequired
namestringrequired
readOnlybooleanrequired
reviewCountintegerrequired
sitesarray of stringrequired
widgetHeightstringrequired
widgetTypestringrequired
widgetWidthstringrequired

Request

Request
curl -X POST 'https://api.synup.com/api/v4/review_widget/edit' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "widgetId": "e4cd2716-ab7a-4218-95f9-302c98959998",
  "minimumRating": 5,
  "name": "testing functionality2 ",
  "readOnly": false,
  "reviewCount": 10,
  "sites": [
    "maps.google.com",
    "facebook.com",
    "yelp.com"
  ],
  "widgetHeight": "470px",
  "widgetType": "medium_slider",
  "widgetWidth": "100%"
}'

Responses

StatusDescription
200
Example response
{
  "data": {
    "editReviewWidget": {
      "widget": {
        "id": "e4cd2716-ab7a-4218-95f9-302c98959998",
        "name": "testing functionality2 ",
        "description": null,
        "widgetType": "medium slider",
        "reviewCount": 10,
        "minimumRating": 5,
        "widgetWidth": "100%",
        "widgetHeight": "470px",
        "sites": [
          "maps.google.com",
          "facebook.com",
          "yelp.com"
        ],
        "readOnly": false,
        "locationId": "TG9jYXRpb246NzAzNTY1",
        "archived": false,
        "createdAt": "2025-08-06 07:32:11.613863",
        "updatedAt": "2025-08-06 07:34:28.132402"
      },
      "errors": null
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectrequired
data.editReviewWidgetobjectrequired
data.editReviewWidget.widgetobjectrequired
data.editReviewWidget.widget.idstringrequired
data.editReviewWidget.widget.namestringrequired
data.editReviewWidget.widget.descriptionnullrequired
data.editReviewWidget.widget.widgetTypestringrequired
data.editReviewWidget.widget.reviewCountintegerrequired
data.editReviewWidget.widget.minimumRatingintegerrequired
data.editReviewWidget.widget.widgetWidthstringrequired
data.editReviewWidget.widget.widgetHeightstringrequired
data.editReviewWidget.widget.sitesarray of stringrequired
data.editReviewWidget.widget.readOnlybooleanrequired
data.editReviewWidget.widget.locationIdstringrequired
data.editReviewWidget.widget.archivedbooleanrequired
data.editReviewWidget.widget.createdAtstringrequired
data.editReviewWidget.widget.updatedAtstringrequired
data.editReviewWidget.errorsnullrequired