> ## 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 company profile > Update any combination of the monitored company's fields (name, description, social handles, AI guidelines). ## OpenAPI ````yaml https://app.octolens.com/api/v2/openapi.json patch /api/v2/org/company 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/org/company: patch: tags: - Organization summary: Update company profile description: >- Update any combination of the monitored company's fields (name, description, social handles, AI guidelines). operationId: updateCompany requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCompanyRequest' responses: '200': description: 200 response content: application/json: schema: $ref: '#/components/schemas/Company' '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: UpdateCompanyRequest: description: >- Partial update of the monitored company profile. Omitted fields are unchanged. type: object properties: name: description: Display name. type: string minLength: 1 description: description: Prose description of the company. type: string twitter: description: X/Twitter handle(s), comma-separated, no `@`. type: string linkedin: description: LinkedIn company slug. type: string logo: description: URL to a public logo image. type: string productUseCases: description: Free-text list (often newline-separated) of use cases. type: string relevanceContext: description: >- Short disambiguation sentence (≤400 chars). Injected into every relevance prompt. type: string maxLength: 400 relevanceGuidelines: description: Extra guidance injected into the relevance-scoring prompt. type: string classificationGuidelines: description: Extra guidance injected into the post-classification prompt. type: string competitors: description: JSON-encoded competitors list (opaque for external clients). type: string companyMoat: description: Prose description of competitive advantage. type: string Company: description: The monitored company profile. type: object properties: id: description: Internal Company row id. type: integer minimum: -9007199254740991 maximum: 9007199254740991 name: description: Company display name. Used as the AI's subject. example: Vercel type: string domain: description: Primary domain (no scheme). example: vercel.com type: string website: description: Full website URL. example: https://vercel.com type: string logo: description: URL to the company logo image. `null` if not enriched yet. anyOf: - type: string - type: 'null' industry: description: >- High-level industry classification (e.g. `Technology`, `SaaS`). Sourced from enrichment and injected into AI prompts. example: Technology type: string sector: description: Finer-grained sector beneath `industry`. example: Developer Tools type: string tags: description: >- Comma-separated category tags. Used as additional AI context for relevance. example: B2B,SaaS,Developer Tools type: string description: description: >- Prose description of the company. Fed into every relevance prompt — keep it factual and specific to improve scoring. type: string linkedin: description: LinkedIn company slug (e.g. `vercel`). `null` if not set. example: vercel anyOf: - type: string - type: 'null' twitter: description: X/Twitter handle without `@`, or comma-separated list. example: vercel anyOf: - type: string - type: 'null' relevanceContext: description: >- Short context sentence (≤400 chars) injected into every AI relevance prompt for this org. Useful for disambiguating common-word brands. example: >- Vercel is a cloud platform for frontend deployments, not a vehicle brand. anyOf: - type: string - type: 'null' productUseCases: description: >- Free-text description (often newline-separated) of what the product does and typical use cases. Injected into relevance prompts. anyOf: - type: string - type: 'null' competitors: description: >- JSON-encoded array of competitor names/descriptions stored as a string. The UI parses this; external clients can treat it opaquely. anyOf: - type: string - type: 'null' companyMoat: description: Prose description of the company's competitive advantage. anyOf: - type: string - type: 'null' relevanceGuidelines: description: >- Org-specific guidelines injected into the `` section of the relevance-scoring prompt. Use this to teach the AI what 'relevant' means for you. anyOf: - type: string - type: 'null' classificationGuidelines: description: >- Org-specific guidelines injected into the `` section of the post-classification/tagging prompt. anyOf: - type: string - type: 'null' required: - id - name - domain - website - logo - industry - sector - tags - description - linkedin - twitter - relevanceContext - productUseCases - competitors - companyMoat - relevanceGuidelines - classificationGuidelines 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 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 `. ````