Keywords

Update a keyword

Rename it (term: the new term is tracked from now on, with no look-back; the mentions the old term found stay), mute or unmute it, reclassify it (kind), change the platforms it is tracked on, its classifier context, its matching rules (each rule field optional; an empty list clears one), or its monthly mention cap (null removes it; a cap above this month's count resumes a capped keyword at once). Rules apply to new mentions from the next poll; stored mentions are untouched.

patch/v1/keywords/{id}

Request

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

Path parameters

idstring required

Keyword id (kw_...).

Example:kw_abc123

Request body

termstring

Renames the keyword: the new term is tracked from now on, with no look-back, and the keyword keeps its id, its settings and the mentions the old term found. Wrap it in double quotes for the exact phrase only. A 409 when its group already tracks the new term.

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

Reclassify it as brand, competitor or topic.

mutedboolean

A muted keyword stops polling and matching; its mentions stay.

platformsstring[] nullable

Replaces the platform list; null means every platform, [] none (reviews only, when the keyword has reviewSources).

contextstring nullable

A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.

groupIdstring

Moves the keyword to this group (grp_...). A 409 when that group already tracks the term.

readsWorkspaceFeedsboolean

true: the keyword also reads the workspace's feeds (GET /v1/feeds), live from now on. false: its own feeds alone.

Response

The updated keyword

idstring required

Keyword id (kw_...).

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

Not polled or matched. Paused by you, by the wallet (see pausedForBalance) or by the noise brake (see pausedForNoise). A keyword at its mention cap is not muted (see pausedForCap).

pausedForBalanceboolean required

Muted by the wallet for lack of balance; a top-up resumes it, unmuting by hand needs balance too.

pausedForNoiseboolean required

Muted by the noise brake: on a workspace running on its welcome credit, at least 20 of its matches were scored and under 30% were relevant. A change of its required or excluded terms, platforms or context resumes it (when the balance covers another day), and so does unmuting; a top-up does not.

pausedForCapboolean required

At its monthly mention cap: not matched until the first of next month (UTC) or until the cap is raised. Not muted: it keeps its place and its daily keyword charge.

platformsstring[] nullable required

Platforms the term is searched on; null means every platform, [] none (the keyword only collects reviews).

readsWorkspaceFeedsboolean required

true (the default): the keyword also reads every feed of the workspace (GET /v1/feeds), on top of its own feeds. false: its own feeds alone.

contextstring nullable required

A sentence the classifier reads for this keyword only, on top of the company profile or the group's own description (at most 300 characters): what the term means here, what to ignore. "Arc is our browser; ignore the geometry word." Null clears it.

createdAtstring required

ISO 8601 timestamp, UTC.

Changes

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