Keywords

Update a keyword

Renames the keyword (term: the new term is tracked from now on, with no look-back, and the mentions the old term found stay), mutes or unmutes it, or changes its kind, platforms, classifier context, matching rules or monthly mention cap. Each rule field is optional and an empty list clears it. A null cap removes the cap, and a cap above this month's count resumes a capped keyword right away. New rules apply to mentions from the next poll on. Stored mentions stay as they are.

patch/v1/keywords/{id}

Request

  • Base URL: https://api.rumoro.dev
  • URL: https://api.rumoro.dev/v1/keywords/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The keyword's id (kw_...).

Example:kw_abc123

Request body

termstring

A new term for the keyword. It keeps its id, settings and the mentions the old term found, and the new term is tracked from now on, with no look-back. A 409 when its group already tracks the new term.

kind'brand' | 'competitor' | 'topic'

New kind (brand, competitor or topic).

mutedboolean

Muting stops polling and matching. Existing mentions are kept.

platformsstring[] nullable

Sets a new platform list. Null means all platforms. An empty list means none, which works when the keyword has reviewSources and only collects reviews.

contextstring nullable

Up to 300 characters the classifier reads for this keyword only, in addition to the company profile or the group's description. Say what the term means for you and what to ignore, for example "Basil is our deploy tool, not the herb." Null clears it.

groupIdstring

Target group (grp_...). 409 if it already has this term.

Response

The keyword after the change

idstring required

The keyword's id (kw_...).

termstring required
kind'brand' | 'competitor' | 'topic' required
mutedboolean required

True when the keyword is neither polled nor matched. You, the wallet (pausedForBalance) or the noise brake (pausedForNoise) can mute it. Reaching the mention cap does not mute it (pausedForCap).

pausedForBalanceboolean required

Muted because the balance ran out. A top-up resumes it. Unmuting it yourself also needs balance.

pausedForNoiseboolean required

Set when the noise brake muted the keyword. That happens on welcome credit once 20 or more matches are scored and under 30% are relevant. Unmuting it, or changing its required or excluded terms, platforms or context, resumes it when the balance covers another day. A top-up alone does not.

pausedForCapboolean required

Hit its monthly mention cap. Matching resumes on the 1st (UTC) or when you raise the cap. The keyword isn't muted and is still charged daily.

platformsstring[] nullable required

The platforms searched for the term. Null means all of them. An empty list means none, and the keyword only collects reviews.

contextstring nullable required

Up to 300 characters the classifier reads for this keyword only, in addition to the company profile or the group's description. Say what the term means for you and what to ignore, for example "Basil is our deploy tool, not the herb." Null clears it.

createdAtstring required

UTC time in ISO 8601.

Changes

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