PATCH · keywords:write

Update keyword

Update keyword text, sources, filters, or active state.

External side effects

REST

PATCH/api/v1/keywords/:keywordId

curl "https://www.stalkr.ai/api/v1/keywords/:keywordId" \
  --request PATCH \
  --header "Authorization: Bearer $STALKR_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: unique-operation-key"

MCP

Tool name: update_keyword

The MCP tool accepts the same input schema and returns the same structured { data, meta } result as REST.

Input

value

string

sources

array

aliases

array

excludedTerms

array

filters

any

caseSensitive

boolean

active

boolean

keywordIdrequired

string

idempotencyKey

string

Unique key used to safely retry this write operation

Safe retries

Pass idempotencyKey to the MCP tool or Idempotency-Key to REST when retrying this write.

Authorization

Required scope: keywords:write.

Scope authorization is followed by resource authorization. Project operations check current membership and the minimum role required by the underlying workflow.

Related resources

REST conventions · MCP setup · Errors and limits