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

Atualizar um widget de avaliações

Atualiza a configuração ou o design de um widget (ou o publica, via status).

patch/api/v1/reviews/widgets/{id}
reviews:write
Parâmetros de consulta
idstringobrigatório
Corpo da solicitação
namestringopcional
minRatingintegeropcional
sourcesarray of stringopcional
selectionModestringopcional
dateWindowstringopcional
manualReviewIdsarray of stringopcional
countintegeropcional
includeInternalbooleanopcional
emojiPositiveRatingintegeropcional
layoutstringopcional
marqueeSpeedintegeropcional
themeobjectopcional
themeOverridesobjectopcional
showFlagsobjectopcional
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
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.
patch/api/v1/reviews/widgets/{id}
Sua chave de API
id *
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 (updated)",
      "minRating": 4,
      "sources": [
        "google"
      ],
      "selectionMode": "recent",
      "dateWindow": "all",
      "manualReviewIds": [],
      "count": 10,
      "layout": "grid",
      "theme": "brand",
      "themeOverrides": null,
      "showFlags": null,
      "status": "published",
      "includeInternal": false,
      "emojiPositiveRating": 4,
      "marqueeSpeed": 5,
      "createdAt": "2026-01-15T09:00:00.000Z",
      "updatedAt": "2026-02-01T09:00:00.000Z",
      "createdByUserId": "cm_user_1",
      "createdByType": "user"
    }
  }
}

Guias que usam este recurso