Synup
Créer une clé
v1Ressources/Reviews/postAjouter un concurrent

Ajouter un concurrent

Commence à suivre un concurrent par son nom — pour un seul emplacement (transmettre locationId et clientId), ou au niveau du client comme concurrent consolidé affiché sur tous les emplacements de ce client (transmettre clientId seul).

post/api/v1/reviews/competitors
reviews:write
Corps de la requête
locationIdstringfacultatif
L'emplacement pour lequel suivre ce concurrent. Omettre avec clientId seul pour ajouter à la place un concurrent consolidé au niveau du client.
clientIdstringfacultatif
Le client de l'emplacement, obligatoire avec locationId ; ou, seul, le client pour lequel ajouter un concurrent consolidé.
namestringobligatoire
Le nom commercial du concurrent.
Réponse
dataobjectfacultatif
competitorobjectfacultatif
Ligne de profil d'un concurrent (id, nom, source, épinglé, etc.).
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/competitors
Votre clé API
Corps de la requête*
{
  "data": {
    "competitor": {
      "id": "cm_comp_1",
      "kind": "competitor",
      "source": "manual",
      "name": "Smile Bright Dental",
      "placeId": null,
      "address": null,
      "lastUpdated": null,
      "avgRating": null,
      "reviewCount": null
    }
  }
}

Guides qui utilisent cet endpoint