Skip to main content
PATCH
/
api
/
v2
/
org
/
company
Update company profile
curl --request PATCH \
  --url https://app.octolens.com/api/v2/org/company \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "twitter": "<string>",
  "linkedin": "<string>",
  "logo": "<string>",
  "productUseCases": "<string>",
  "relevanceContext": "<string>",
  "relevanceGuidelines": "<string>",
  "classificationGuidelines": "<string>",
  "competitors": "<string>",
  "companyMoat": "<string>"
}
'
{
  "id": 0,
  "name": "Vercel",
  "domain": "vercel.com",
  "website": "https://vercel.com",
  "logo": "<string>",
  "industry": "Technology",
  "sector": "Developer Tools",
  "tags": "B2B,SaaS,Developer Tools",
  "description": "<string>",
  "linkedin": "vercel",
  "twitter": "vercel",
  "relevanceContext": "Vercel is a cloud platform for frontend deployments, not a vehicle brand.",
  "productUseCases": "<string>",
  "competitors": "<string>",
  "companyMoat": "<string>",
  "relevanceGuidelines": "<string>",
  "classificationGuidelines": "<string>"
}

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.

Authorizations

​
Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>.

Body

application/json

Partial update of the monitored company profile. Omitted fields are unchanged.

​
name
string

Display name.

Minimum string length: 1
​
description
string

Prose description of the company.

​
twitter
string

X/Twitter handle(s), comma-separated, no @.

​
linkedin
string

LinkedIn company slug.

URL to a public logo image.

​
productUseCases
string

Free-text list (often newline-separated) of use cases.

​
relevanceContext
string

Short disambiguation sentence (≤400 chars). Injected into every relevance prompt.

Maximum string length: 400
​
relevanceGuidelines
string

Extra guidance injected into the relevance-scoring prompt.

​
classificationGuidelines
string

Extra guidance injected into the post-classification prompt.

​
competitors
string

JSON-encoded competitors list (opaque for external clients).

​
companyMoat
string

Prose description of competitive advantage.

Response

200 response

The monitored company profile.

​
id
integer
required

Internal Company row id.

Required range: -9007199254740991 <= x <= 9007199254740991
​
name
string
required

Company display name. Used as the AI's subject.

Example:

"Vercel"

​
domain
string
required

Primary domain (no scheme).

Example:

"vercel.com"

​
website
string
required

Full website URL.

Example:

"https://vercel.com"

​
logo
string | null
required

URL to the company logo image. null if not enriched yet.

​
industry
string
required

High-level industry classification (e.g. Technology, SaaS). Sourced from enrichment and injected into AI prompts.

Example:

"Technology"

​
sector
string
required

Finer-grained sector beneath industry.

Example:

"Developer Tools"

​
tags
string
required

Comma-separated category tags. Used as additional AI context for relevance.

Example:

"B2B,SaaS,Developer Tools"

​
description
string
required

Prose description of the company. Fed into every relevance prompt — keep it factual and specific to improve scoring.

​
linkedin
string | null
required

LinkedIn company slug (e.g. vercel). null if not set.

Example:

"vercel"

​
twitter
string | null
required

X/Twitter handle without @, or comma-separated list.

Example:

"vercel"

​
relevanceContext
string | null
required

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."

​
productUseCases
string | null
required

Free-text description (often newline-separated) of what the product does and typical use cases. Injected into relevance prompts.

​
competitors
string | null
required

JSON-encoded array of competitor names/descriptions stored as a string. The UI parses this; external clients can treat it opaquely.

​
companyMoat
string | null
required

Prose description of the company's competitive advantage.

​
relevanceGuidelines
string | null
required

Org-specific guidelines injected into the <specific_guidelines> section of the relevance-scoring prompt. Use this to teach the AI what 'relevant' means for you.

​
classificationGuidelines
string | null
required

Org-specific guidelines injected into the <specific_guidelines> section of the post-classification/tagging prompt.