Synup
Create a key
v1Resources/Reviews/postCreate a review widget

Create a review widget

Creates a new embeddable review widget (rating badge + review carousel/list) for a location.

post/api/v1/reviews/widgets
reviews:write
Request body
locationIdstringrequired
clientIdstringrequired
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstring (30d | 90d | 1y | all)optional
countintegeroptional
includeInternalbooleanoptional
layoutstringoptional
statusstring (draft | published)optional
Response
dataobjectoptional
widgetobjectoptional
idstringoptional
agencyIdstringoptional
locationIdstringoptional
clientLocationIdstringoptional
namestringoptional
minRatingintegeroptional
sourcesarray of stringoptional
selectionModestringoptional
dateWindowstringoptional
manualReviewIdsarray of stringoptional
countintegeroptional
includeInternalbooleanoptional
emojiPositiveRatingintegeroptional
layoutstringoptional
marqueeSpeedintegeroptional
themeobjectoptional
themeOverridesobjectoptional
showFlagsobjectoptional
statusstring (draft | published)optional
createdAtstringoptional
updatedAtstringoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/reviews/widgets
Your API key
Request body*
{
  "data": {
    "widget": {
      "id": "cm_widget_1",
      "agencyId": "cm_agency_1",
      "locationId": "cm_loc_1",
      "clientLocationId": "cm_loc_1",
      "name": "Homepage reviews",
      "minRating": 4,
      "sources": [],
      "selectionMode": "recent",
      "dateWindow": "all",
      "manualReviewIds": [],
      "count": 10,
      "layout": "carousel",
      "theme": "brand",
      "themeOverrides": null,
      "showFlags": null,
      "status": "published",
      "includeInternal": false,
      "emojiPositiveRating": 4,
      "marqueeSpeed": 5,
      "createdAt": "2026-01-15T09:00:00.000Z",
      "updatedAt": "2026-01-15T09:00:00.000Z",
      "createdByUserId": "cm_user_1",
      "createdByType": "user"
    }
  }
}

Guides that use this endpoint