v1Resources/Social Listening/postAdd a listening competitor
Add a listening competitor
Adds a competitor to track. A competitor you archived earlier comes back instead of duplicating.
post
listening:write/api/v1/listening/competitorsRequest body
clientIdstringrequired
The client (business) this concerns.
namestringrequired
The competitor's name.
aliasesarray of stringoptional
Other names people use for it, up to 10.
handlesobjectoptional
Its accounts by network, for example { "x": ["peets"] }.
websitestringoptional
Its website.
Response
dataobjectoptional
competitorobjectoptional
The competitor that was added.
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.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/listening/competitors
Your API key
Request body*
{}