---
title: "Update a keyword"
description: "Mutes or unmutes the keyword, 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."
canonical: https://docs.rumoro.dev/api/keywords/update-keyword
markdown: https://docs.rumoro.dev/api/keywords/update-keyword.mdx
---

# Update a keyword

`PATCH /v1/keywords/{id}`

Mutes or unmutes the keyword, 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.

## Parameters

| Name | In | Description |
| --- | --- | --- |
| `id` | path, required | The keyword's id (kw_...). |

## Body

| Field | Required | Description |
| --- | --- | --- |
| `kind` |  | New kind (brand, competitor or topic). |
| `muted` |  | Muting stops polling and matching. Existing mentions are kept. |
| `platforms` |  | 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. |
| `context` |  | 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 "Driftwood is our deploy tool, not beach wood." Null clears it. |
| `matching` |  | Fields you leave out stay as they are. An empty list clears a field. |
| `cap` |  | Sets a new monthly mention cap, or null for no cap. A cap above this month's count resumes a capped keyword right away. A cap at or below the count pauses it. |
| `groupId` |  | Target group (grp_...). 409 if it already has this term. |
| `reviewSources` |  | Sets a new list of review pages for this keyword. An empty list disconnects them all, and their reviews are kept. A page or country you add gets the free 30-day look-back. Pages already listed are unchanged. |

## Responses

| Status | Meaning |
| --- | --- |
| 200 | The keyword after the change |
| 401 | The API key is missing or not valid |
| 402 | The balance can't cover another keyword-day (insufficient_balance), or the workspace already runs 500 keywords (keyword_limit_reached) |
| 404 | No keyword with this id |

The [OpenAPI document](https://api.rumoro.dev/v1/openapi.json) has every schema. Rules shared by all endpoints are in [Conventions](https://docs.rumoro.dev/conventions.mdx).
