Change keyword settings
keyword_updateChange a keyword's settings: name, default interval, sorting, sentiment, co-brands, agent step, subject role, mute rules, VIP authors, rules, webhook, schedule and channels. A key you leave out is left alone; null clears it. Never its Sources or searches: that is keyword_source_set, so this tool starts no search over. Call keyword_estimate with the same arguments first: it runs the same validation, writes nothing, and returns the price and the estimateToken this tool requires. Starts or changes polling that is charged per check at each Source's credit rate (AI answers per engine asked) until the keyword or the Source is paused. Call keyword_estimate first, show the person the monthlyCredits it returns, and send its estimateToken only after they agree.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Keyword id, from list_keywords. Another account's id is a 404, never a 403. | |
| name | No | ||
| color | No | The keyword colour in the dashboard. Left out on create, an unused one is picked. | |
| rules | No | Replaces the list. Copy the shape from get_keyword on an existing keyword. | |
| aiStep | No | Your own question asked of every mention, with the fields to fill: {"instruction": one or two sentences, 800 characters at most, "schema": 1 to 12 flat fields, each {"type": "string" | "number" | "boolean" | "enum", "description", "values" for an enum, "maxLength" for a string}}, no nesting and no arrays. The answer arrives on each event as analysis. Costs 1 credit per 25 items, on top of the check rate. Delivery waits up to 120s for it; on timeout the event is still delivered, with the answer null and a status saying why. null removes it. | |
| aiPreset | No | ||
| aiPrompt | No | ||
| channels | No | Replaces the delivery channels attached to the keyword. | |
| schedule | No | An activation window with ISO instants. null keeps the keyword always on. | |
| aiEnabled | No | Sort mentions into buckets. | |
| muteRules | No | Replaces the list. A plain string mutes that word. | |
| vipAuthors | No | Replaces the list. A plain string is a handle. | |
| webhookUrl | No | A publicly reachable HTTPS endpoint the person controls: new mentions are POSTed there. Never invent this URL, ask the person for it. Left out, the keyword records what it catches without pushing it, and you read it with list_mentions, get_keyword_results or get_keyword_events. null removes the webhook. | |
| subjectRole | No | What the keyword is about: your own brand, a competitor's, or a topic. A new topic without globalCriteria.match is created with match word. | |
| webhookMode | No | all delivers every new mention; rules delivers only what a rule routes. | |
| estimateToken | Yes | The estimateToken keyword_estimate returned for exactly these arguments. Valid 15 minutes. A token for other arguments is refused: estimate again. | |
| coBrandsEnabled | No | AI answers only: also read each answer for the other brands it names, charged per answer on top of the run. | |
| relevanceContext | No | One sentence the AI reading uses to judge relevance, such as "Acme is a cloud storage company, not the cartoon." null clears it. | |
| sentimentEnabled | No | Read every mention for sentiment and intent. | |
| refreshIntervalSeconds | No | Default seconds between checks, for every Source without its own interval. The plan and each Source set a floor; the estimate names the band when a value is outside it. |