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
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type | string | required |
Body
| Name | Type | Required | Description |
|---|---|---|---|
widgetId | string | required | |
minimumRating | integer | required | |
name | string | required | |
readOnly | boolean | required | |
reviewCount | integer | required | |
sites | array of string | required | |
widgetHeight | string | required | |
widgetType | string | required | |
widgetWidth | string | required |
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%"
}'const res = await fetch('https://api.synup.com/api/v4/review_widget/edit', {
method: 'POST',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"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%"
}),
});
const data = await res.json();import requests
res = requests.post(
"https://api.synup.com/api/v4/review_widget/edit",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
json={
"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%"
},
)
data = res.json()req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/review_widget/edit", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
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
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | |
data.editReviewWidget | object | required | |
data.editReviewWidget.widget | object | required | |
data.editReviewWidget.widget.id | string | required | |
data.editReviewWidget.widget.name | string | required | |
data.editReviewWidget.widget.description | null | required | |
data.editReviewWidget.widget.widgetType | string | required | |
data.editReviewWidget.widget.reviewCount | integer | required | |
data.editReviewWidget.widget.minimumRating | integer | required | |
data.editReviewWidget.widget.widgetWidth | string | required | |
data.editReviewWidget.widget.widgetHeight | string | required | |
data.editReviewWidget.widget.sites | array of string | required | |
data.editReviewWidget.widget.readOnly | boolean | required | |
data.editReviewWidget.widget.locationId | string | required | |
data.editReviewWidget.widget.archived | boolean | required | |
data.editReviewWidget.widget.createdAt | string | required | |
data.editReviewWidget.widget.updatedAt | string | required | |
data.editReviewWidget.errors | null | required |