---
title: "Add Review Widget"
method: POST
path: "/review_widget/add"
tags: ["Reviews", "Interactions"]
---

# Add Review Widget

`POST /review_widget/add`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/review_widget/add`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/review_widget/add/post.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `Authorization` string, required
- `Content-Type` string, required

## Request body

- object
  - `locationId` string, required
  - `minimumRating` integer, required
  - `name` string, required
  - `readOnly` boolean, required
  - `reviewCount` integer, required
  - `sites` string[], required
  - `widgetHeight` string, required
  - `widgetType` string, required
  - `widgetWidth` string, required

## Response `200`

- object
  - `data` object, required
    - `addReviewWidget` object, required
      - `widget` unknown, required
      - `errors` object[], required
        - `contextInfo` object[]
          - `key` string
          - `value` string
        - `code` string
        - `message` string

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)