Synup
Créer une clé
v1Ressources/Reviews/postCréer un widget d'avis

Créer un widget d'avis

Crée un nouveau widget d'avis intégrable (badge de note + carrousel/liste d'avis) pour un emplacement.

post/api/v1/reviews/widgets
reviews:write
Corps de la requête
locationIdstringobligatoire
clientIdstringobligatoire
namestringfacultatif
minRatingintegerfacultatif
sourcesarray of stringfacultatif
selectionModestringfacultatif
dateWindowstring (30d | 90d | 1y | all)facultatif
countintegerfacultatif
includeInternalbooleanfacultatif
layoutstringfacultatif
statusstring (draft | published)facultatif
Réponse
dataobjectfacultatif
widgetobjectfacultatif
idstringfacultatif
agencyIdstringfacultatif
locationIdstringfacultatif
clientLocationIdstringfacultatif
namestringfacultatif
minRatingintegerfacultatif
sourcesarray of stringfacultatif
selectionModestringfacultatif
dateWindowstringfacultatif
manualReviewIdsarray of stringfacultatif
countintegerfacultatif
includeInternalbooleanfacultatif
emojiPositiveRatingintegerfacultatif
layoutstringfacultatif
marqueeSpeedintegerfacultatif
themeobjectfacultatif
themeOverridesobjectfacultatif
showFlagsobjectfacultatif
statusstring (draft | published)facultatif
createdAtstringfacultatif
updatedAtstringfacultatif
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/widgets
Votre clé API
Corps de la requête*
{
  "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 qui utilisent cet endpoint