Synup
Criar chave
v1Recursos/Reviews/postCriar um widget de avaliações

Criar um widget de avaliações

Cria um novo widget de avaliações incorporável (selo de classificação + carrossel/lista de avaliações) para um local.

post/api/v1/reviews/widgets
reviews:write
Corpo da solicitação
locationIdstringobrigatório
clientIdstringobrigatório
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstring (30d | 90d | 1y | all)opcional
countintegeropcional
includeInternalbooleanopcional
layoutstringopcional
statusstring (draft | published)opcional
Resposta
dataobjectopcional
widgetobjectopcional
idstringopcional
agencyIdstringopcional
locationIdstringopcional
clientLocationIdstringopcional
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstringopcional
manualReviewIdsarray of stringopcional
countintegeropcional
includeInternalbooleanopcional
emojiPositiveRatingintegeropcional
layoutstringopcional
marqueeSpeedintegeropcional
themeobjectopcional
themeOverridesobjectopcional
showFlagsobjectopcional
statusstring (draft | published)opcional
createdAtstringopcional
updatedAtstringopcional
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/reviews/widgets
Sua chave de API
Corpo da solicitação*
{
  "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"
    }
  }
}

Guias que usam este endpoint