v1Resources/Social Listening/patchUpdate a listening topic
Update a listening topic
Edits a topic, or turns it on or off with status. Turning a topic on schedules its first collection for the next monthly update; it does not start one now. A client needs a connected social account before a topic can be turned on.
patch
listening:write/api/v1/listening/topics/{id}Query parameters
idstringrequired
The topic's id.
Request body
clientIdstringrequired
The client (business) this concerns.
namestringoptional
The topic's name, up to 80 characters.
descriptionstringoptional
An optional note, up to 255 characters. Send null to clear it.
queryobjectoptional
A replacement query, in the same shape as when creating a topic.
sourcesarray of stringoptional
The networks to follow.
languagesarray of stringoptional
Up to five two-letter language codes.
statusstring (active | paused | suggested)optional
active collects, paused stops, suggested keeps it as an idea.
Response
dataobjectoptional
topicobjectoptional
The topic after the change.
collectsNextstringoptional
When an active topic will next be collected, as a date-time. Present only when the change turned a topic on.
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/topics/{id}
Your API key
id *
Request body*
{}