v1Resources/Social Listening/patchUpdate a listening competitor
Update a listening competitor
Edits a competitor's name, aliases, handles or website, or accepts a suggested one with status active.
patch
listening:write/api/v1/listening/competitors/{id}Query parameters
idstringrequired
The competitor's id.
Request body
clientIdstringrequired
The client (business) this concerns.
namestringoptional
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.
statusstring (active | suggested)optional
Set active to accept a suggested competitor.
Response
dataobjectoptional
competitorobjectoptional
The competitor after the change.
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.
patch/api/v1/listening/competitors/{id}
Your API key
id *
Request body*
{}