v1Resources/Social Listening/postCreate a listening topic
Create a listening topic
Creates a topic as a suggestion. It collects nothing until you turn it on with a PATCH that sets status to active.
post
listening:write/api/v1/listening/topicsRequest body
clientIdstringrequired
The client (business) this concerns.
namestringrequired
The topic's name, up to 80 characters.
descriptionstringoptional
An optional note, up to 255 characters.
kindstring (brand | competitor | product | industry | campaign | custom)required
What the topic is about. A competitor topic also needs competitorId.
competitorIdstringoptional
The competitor a competitor topic follows.
queryobjectrequired
What to find. include is a list of alternatives (OR); each alternative is a list of term groups (AND), and a term group is { match: "all" | "any", terms: [...] }. Optional exclude lists terms that rule a post out, and fromHandles names accounts to watch by network.
sourcesarray of stringrequired
The networks to follow: x, reddit, bluesky, tiktok, instagram, facebook, youtube, news, web, reviews.
languagesarray of stringoptional
Up to five two-letter language codes. Empty means any language.
Response
dataobjectoptional
topicobjectoptional
The topic that was created.
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/listening/topics
Your API key
Request body*
{}