follow

Follow Topic

Follow a topic for the signed-in user from confirmed targets. Returns the followed topic with follow_id.

Send confirmed: true, a label (or query), and targets from find_topics_to_follow, a phrase, or both. Without confirmation, or with neither targets nor a phrase, the response is 409 confirmation_required carrying the resolution to show first. When the query names a subject, Scout also follows it by meaning and returns phrase.description, a plain statement of what it reads the phrase as; meaning-based updates show on the Following page and do not email yet. A phrase that is too broad returns 409 phrase_too_broad: ask the user to narrow it, or resend with keep_broad: true to keep it page only. A new followed topic starts with matches from the last 90 days. At most 20 active followed topics per user, phrase follows included (409 follow_limit_reached). Delivery defaults to the user's setting (email unless changed).

post/follows

Request

  • Base URL: https://api.3gppscout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.3gppscout.com/follows
  • Auth: none declared

Request body

querystring nullable

What the user asked to follow.

labelstring nullable

User-facing name. Defaults to the query.

delivery'default' | 'email' | 'dashboard'
created_via'chat_tool' | 'suggestion' | 'api' | 'mcp' | 'page' nullable
source_thread_idstring nullable
confirmedboolean

Set true only after the user saw the label and targets. Without it, or without targets or a phrase, the response is 409 confirmation_required with the resolution to show.

phrasestring nullable

Follow this phrase by meaning, with or without targets. Defaults to the query when it names a subject (not only a spec, meeting or company). Send an empty string to follow the targets only.

keep_broadboolean

Keep a phrase Scout found too broad (409 phrase_too_broad). The follow is then page only: its updates show on the Following page and it sends no email.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.