Pause or resume a keyword
Moves a keyword to an explicit paused state. The write is ABSOLUTE and idempotent — { "paused": true } on an already-paused keyword changes nothing and answers changed: false — so it is safe to retry and safe to call concurrently. The paused field in the response is the COMMITTED value read back after the write, never an echo of the request.
Authorizations
Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.
Path Parameters
-9007199254740991 <= x <= 9007199254740991Body
The paused state to move a keyword to.
Target state: true pauses data collection, false resumes it. The write is absolute and idempotent — sending the state the keyword is already in changes nothing and answers changed: false.
true
Response
200 response
The committed keyword row plus whether this request changed it.
Stable numeric keyword ID.
-9007199254740991 <= x <= 900719925474099142
The phrase being tracked.
"acme corp"
Short sentence disambiguating the keyword for AI relevance scoring. Auto-generated from the company profile when a keyword is created without an explicit context.
"Acme is a cloud storage company, not the cartoon."
Additional terms required alongside the main keyword (comma-separated). Combined with additionalTermsAndOr to form AND/OR semantics.
"deployment, preview"
How additionalTerms combine: true = OR (any one must appear), false = AND (all must appear).
If true, matching is case-sensitive. Default false.
Also known as "exact match" in the UI. When true, multi-word keywords require the words to appear together. When false, each word can appear anywhere in the post (noisier).
Platforms this keyword is monitored on.
Platform a mention can originate from / a keyword can be monitored on.
dev, github, hackernews, linkedin, producthunt, reddit, stackoverflow, twitter, youtube, tiktok, medium, reddit_comment, bluesky, newsletter, podcasts, news, firehose Comma-separated words that disqualify a post if present. Applied as exact-match terms.
"jobs, hiring, is-for-sale"
Comma-separated wildcard exclusion patterns. Supports * for prefix/suffix match (e.g. spam* matches spammer).
Comma-separated author handles / usernames whose posts should be filtered out.
"spambot1, crypto_guy"
Classification tag. null for legacy keywords without a tag.
own_brand, competitor, industry_term "own_brand"
When true, data collection is paused for this keyword.
When true, this keyword represents a subreddit to monitor rather than a free-text phrase. null for non-Reddit keywords.
True when THIS request is the one that moved the row; false when the keyword was already in the requested state (or a concurrent identical request won the race).
true
