POSTapi.synup.com/api/v4/review_widget/addBeta

Add 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
`locationId`	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

curl -X POST 'https://api.synup.com/api/v4/review_widget/add' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "locationId": "TG9jYXRpb246NzAzNTY1",
  "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/add', {
  method: 'POST',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "locationId": "TG9jYXRpb246NzAzNTY1",
    "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/add",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
      "locationId": "TG9jYXRpb246NzAzNTY1",
      "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/add", 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": {
    "addReviewWidget": {
      "widget": null,
      "errors": [
        {
          "contextInfo": [
            {
              "key": "name",
              "value": "testing functionality2 "
            }
          ],
          "code": "SY50101",
          "message": "Widget name testing functionality2  already used"
        }
      ]
    }
  }
}

Response body

Name	Type	Required
`data`	object	required
`data.addReviewWidget`	object	required
`data.addReviewWidget.widget`	null	required
`data.addReviewWidget.errors`	array of object	required
`data.addReviewWidget.errors[].contextInfo`	array of object	optional
`data.addReviewWidget.errors[].contextInfo[].key`	string	optional
`data.addReviewWidget.errors[].contextInfo[].value`	string	optional
`data.addReviewWidget.errors[].code`	string	optional
`data.addReviewWidget.errors[].message`	string	optional