Synup
Create a key
v1Resources/Reviews/postAdd a competitor

Add a competitor

Starts tracking a competitor by name — for a single location (pass locationId and clientId), or client-wide as a roll-up competitor shown across every one of that client's locations (pass clientId alone).

post/api/v1/reviews/competitors
reviews:write
Request body
locationIdstringoptional
The location to track this competitor for. Omit alongside clientId alone to add a client-wide roll-up competitor instead.
clientIdstringoptional
The location's client, required alongside locationId; or, on its own, the client to add a roll-up competitor for.
namestringrequired
The competitor's business name.
Response
dataobjectoptional
competitorobjectoptional
One competitor's profile row (id, name, source, pinned, etc.).
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/competitors
Your API key
Request body*
{
  "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 that use this endpoint