v1Resources/Reviews/postAdd a competitor

Add a competitor

Starts tracking a competitor by name for a location.

post/api/v1/reviews/competitors
reviews:write
Request body
locationIdstringoptional
apiDocs.resources.reviews.competitors.post.paramsLocationId
clientIdstringoptional
apiDocs.resources.reviews.competitors.post.paramsClientId
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*
{}