> ## Documentation Index > Fetch the complete documentation index at: https://octolens.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a keyword ## OpenAPI ````yaml https://app.octolens.com/api/v2/openapi.json patch /api/v2/keywords/{id} openapi: 3.1.0 info: title: Octolens API version: 2.0.0 description: >- The Octolens API lets you query mentions, manage keywords, and configure feeds programmatically. Every action available in the Octolens UI is available here. ### Authentication All v2 endpoints require an API key. Create one in **Settings > API** and pass it as `Authorization: Bearer `. Keys are scoped to the organization they were minted in; you cannot access another org's data. API keys carry a scope — `read`, `write` (implies read), or `admin` (implies write). Each endpoint documents the scope it needs via the `x-required-scope` OpenAPI extension and the scope badge in the docs surface. ### Rate limiting The v2 API is rate-limited at **500 requests per hour per organization**, across all keys for that org. The limit resets at the top of each hour (sliding hourly window). Every 2xx response carries three headers so clients can pace themselves: * `X-RateLimit-Limit` — the hourly cap (500) * `X-RateLimit-Remaining` — requests left in the current window * `X-RateLimit-Reset` — Unix timestamp (seconds) when the window resets When the cap is hit, the endpoint returns **429 Rate Limited** with an additional `Retry-After` header (seconds until the next window). The response body is the standard `ErrorResponse` with `code: "RATE_LIMITED"`. ### Error handling All non-2xx responses share the same `ErrorResponse` envelope: `{ error: { code, message, status, details? } }`. The `code` field is a stable `ApiErrorCode` enum — branch on it programmatically instead of parsing `message`. See the `ApiErrorCode` schema for the full catalog grouped by category. `VALIDATION_ERROR` (400) responses include a `details` array with per-field Zod issues — inspect `details[i].path` to pinpoint which input was rejected. ### Building filter bodies Endpoints that accept `simpleFilters` / `advancedFilters` (e.g. `POST /api/v2/mentions`, `PATCH /api/v2/feeds/{id}`) take a structured object that can be tricky to hand-craft. If you just have a natural-language description of what you want ("negative posts about pricing on reddit in the last week"), call `POST /api/v2/ai/filter-wizard` with that prompt and it will return a ready-to-use filter object you can pass straight through. servers: - url: https://app.octolens.com description: Production - url: http://localhost:3000 description: Local development security: - ApiKey: [] paths: /api/v2/keywords/{id}: patch: tags: - Keywords summary: Update a keyword operationId: updateKeyword parameters: - in: path name: id schema: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateKeywordRequest' responses: '200': description: 200 response content: application/json: schema: $ref: '#/components/schemas/Keyword' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Missing or invalid authentication content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden (insufficient plan or permissions) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: UpdateKeywordRequest: description: >- Partial update. Omitted fields are left unchanged. Pass an empty string to clear a text-list field; pass an empty array to require explicit platform reset (not allowed). type: object properties: context: description: Replace the relevance-context sentence. type: string maxLength: 200 additionalTerms: description: Replace comma-separated additional terms. Empty string clears. type: string maxLength: 500 additionalTermsAndOr: description: OR (`true`) or AND (`false`) for additional terms. type: boolean caseSensitive: description: Toggle case-sensitive matching. type: boolean symbolSensitive: description: Toggle "exact match" mode. type: boolean platforms: description: >- Replace the platforms list. Must be a non-empty subset of plan-allowed sources. minItems: 1 type: array items: $ref: '#/components/schemas/Platform' excludeWords: description: Replace comma-separated exact-match exclusions. Empty string clears. type: string maxLength: 1000 wildcardExcludeWords: description: Replace comma-separated wildcard exclusions. Empty string clears. type: string maxLength: 1000 excludeAuthors: description: >- Replace comma-separated excluded author handles. Empty string clears. type: string maxLength: 1000 tag: $ref: '#/components/schemas/KeywordTag' Keyword: description: One monitored keyword. type: object properties: id: description: Stable numeric keyword ID. example: 42 type: integer minimum: -9007199254740991 maximum: 9007199254740991 keyword: description: The phrase being tracked. example: acme corp type: string context: description: >- Short sentence disambiguating the keyword for AI relevance scoring. Auto-generated from the company profile when a keyword is created without an explicit context. example: Acme is a cloud storage company, not the cartoon. anyOf: - type: string - type: 'null' additionalTerms: description: >- Additional terms required alongside the main keyword (comma-separated). Combined with `additionalTermsAndOr` to form AND/OR semantics. example: deployment, preview anyOf: - type: string - type: 'null' additionalTermsAndOr: description: >- How `additionalTerms` combine: `true` = OR (any one must appear), `false` = AND (all must appear). type: boolean caseSensitive: description: If `true`, matching is case-sensitive. Default `false`. type: boolean symbolSensitive: description: >- Also known as "exact match" in the UI. When `true`, multi-word keywords require the words to appear together. When `false`, each word can appear anywhere in the post (noisier). type: boolean platforms: description: Platforms this keyword is monitored on. example: - reddit - twitter - youtube type: array items: $ref: '#/components/schemas/Platform' excludeWords: description: >- Comma-separated words that disqualify a post if present. Applied as exact-match terms. example: jobs, hiring, is-for-sale anyOf: - type: string - type: 'null' wildcardExcludeWords: description: >- Comma-separated wildcard exclusion patterns. Supports `*` for prefix/suffix match (e.g. `spam*` matches `spammer`). anyOf: - type: string - type: 'null' excludeAuthors: description: >- Comma-separated author handles / usernames whose posts should be filtered out. example: spambot1, crypto_guy anyOf: - type: string - type: 'null' tag: description: Classification tag. `null` for legacy keywords without a tag. anyOf: - $ref: '#/components/schemas/KeywordTag' - type: 'null' paused: description: When `true`, data collection is paused for this keyword. type: boolean isSubReddit: description: >- When `true`, this keyword represents a subreddit to monitor rather than a free-text phrase. `null` for non-Reddit keywords. anyOf: - type: boolean - type: 'null' required: - id - keyword - context - additionalTerms - additionalTermsAndOr - caseSensitive - symbolSensitive - platforms - excludeWords - wildcardExcludeWords - excludeAuthors - tag - paused - isSubReddit additionalProperties: false ErrorResponse: description: >- Standard error envelope returned for all non-2xx responses. The `code` field is stable — safe to branch on programmatically. type: object properties: error: type: object properties: code: $ref: '#/components/schemas/ApiErrorCode' description: >- Machine-readable error code. See `ApiErrorCode` for the full list. example: NOT_FOUND message: description: Human-readable error message. example: Resource not found type: string status: description: HTTP status code — always matches the response status. example: 404 type: integer minimum: -9007199254740991 maximum: 9007199254740991 details: description: >- Present on `VALIDATION_ERROR` responses. Contains Zod issues describing each failing field (path, code, message). type: array items: {} required: - code - message - status additionalProperties: false required: - error additionalProperties: false Platform: description: Platform a mention can originate from / a keyword can be monitored on. example: reddit type: string enum: - dev - github - hackernews - linkedin - producthunt - reddit - stackoverflow - twitter - youtube - tiktok - medium - reddit_comment - bluesky - newsletter - podcasts - news - firehose KeywordTag: description: >- Classification of what this keyword represents. Used to route posts to brand / competitor / industry-context workflows and pick the right AI prompt. example: own_brand type: string enum: - own_brand - competitor - industry_term ApiErrorCode: description: >- Stable, machine-readable error code. Grouped as follows: **Auth / request shape** — `UNAUTHORIZED` (401), `FORBIDDEN` (403), `RATE_LIMITED` (429), `VALIDATION_ERROR` (400 — response carries a `details` array with Zod issues), `INTERNAL_ERROR` (500). **Not found (404)** — generic `NOT_FOUND` plus domain-specific variants: `FEED_NOT_FOUND`, `KEYWORD_NOT_FOUND`, `POST_NOT_FOUND`, `SUMMARY_NOT_FOUND`, `SUGGESTION_NOT_FOUND`, `COMPANY_NOT_FOUND`, `ORG_NOT_FOUND`, `SETTINGS_NOT_FOUND`. **Business-rule violations (400)** — `KEYWORD_LIMIT_EXCEEDED` (plan cap hit), `LAST_ADMIN` (refuses to remove the only admin), `ITEM_EXISTS` (duplicate), `INVALID_DOMAIN`, `INVALID_TIMEZONE`. type: string enum: - UNAUTHORIZED - FORBIDDEN - RATE_LIMITED - VALIDATION_ERROR - INTERNAL_ERROR - NOT_FOUND - FEED_NOT_FOUND - KEYWORD_NOT_FOUND - POST_NOT_FOUND - SUMMARY_NOT_FOUND - SUGGESTION_NOT_FOUND - COMPANY_NOT_FOUND - ORG_NOT_FOUND - SETTINGS_NOT_FOUND - KEYWORD_LIMIT_EXCEEDED - LAST_ADMIN - ITEM_EXISTS - INVALID_DOMAIN - INVALID_TIMEZONE securitySchemes: ApiKey: type: http scheme: bearer description: >- Clerk API key. Create one in Settings → API Keys. Pass as `Authorization: Bearer `. ````