Update company profile

PATCH

api

org

company

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>"
}
'

import requests

url = "https://app.octolens.com/api/v2/org/company"

payload = {
    "name": "<string>",
    "description": "<string>",
    "twitter": "<string>",
    "linkedin": "<string>",
    "logo": "<string>",
    "productUseCases": "<string>",
    "relevanceContext": "<string>",
    "relevanceGuidelines": "<string>",
    "classificationGuidelines": "<string>",
    "competitors": "<string>",
    "companyMoat": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    twitter: '<string>',
    linkedin: '<string>',
    logo: '<string>',
    productUseCases: '<string>',
    relevanceContext: '<string>',
    relevanceGuidelines: '<string>',
    classificationGuidelines: '<string>',
    competitors: '<string>',
    companyMoat: '<string>'
  })
};

fetch('https://app.octolens.com/api/v2/org/company', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.octolens.com/api/v2/org/company",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'twitter' => '<string>',
    'linkedin' => '<string>',
    'logo' => '<string>',
    'productUseCases' => '<string>',
    'relevanceContext' => '<string>',
    'relevanceGuidelines' => '<string>',
    'classificationGuidelines' => '<string>',
    'competitors' => '<string>',
    'companyMoat' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.octolens.com/api/v2/org/company"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"linkedin\": \"<string>\",\n  \"logo\": \"<string>\",\n  \"productUseCases\": \"<string>\",\n  \"relevanceContext\": \"<string>\",\n  \"relevanceGuidelines\": \"<string>\",\n  \"classificationGuidelines\": \"<string>\",\n  \"competitors\": \"<string>\",\n  \"companyMoat\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.octolens.com/api/v2/org/company")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"linkedin\": \"<string>\",\n  \"logo\": \"<string>\",\n  \"productUseCases\": \"<string>\",\n  \"relevanceContext\": \"<string>\",\n  \"relevanceGuidelines\": \"<string>\",\n  \"classificationGuidelines\": \"<string>\",\n  \"competitors\": \"<string>\",\n  \"companyMoat\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/org/company")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"linkedin\": \"<string>\",\n  \"logo\": \"<string>\",\n  \"productUseCases\": \"<string>\",\n  \"relevanceContext\": \"<string>\",\n  \"relevanceGuidelines\": \"<string>\",\n  \"classificationGuidelines\": \"<string>\",\n  \"competitors\": \"<string>\",\n  \"companyMoat\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

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. Max 191 characters.

Required string length: 1 - 191

description

string

Prose description of the company. Max 10000 characters.

Maximum string length: 10000

twitter

string

X/Twitter handle(s), comma-separated, no @. Max 191 characters. Pass an empty string to clear.

Maximum string length: 191

string

LinkedIn company slug. Max 191 characters. Pass an empty string to clear.

Maximum string length: 191

logo

string<uri>

URL to a public logo image. Must be an absolute http(s) URL.

productUseCases

string

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

Maximum string length: 10000

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. Max 10000 characters.

Maximum string length: 10000

classificationGuidelines

string

Extra guidance injected into the post-classification prompt. Max 10000 characters.

Maximum string length: 10000

competitors

string

JSON-encoded competitors list — an array of {"name": string, "description"?: string}. Pass an empty string to clear.

Maximum string length: 20000

companyMoat

string

Prose description of competitive advantage. Max 10000 characters.

Maximum string length: 10000

Response

200 response

The monitored company profile.

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.

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.

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>"
}
'

import requests

url = "https://app.octolens.com/api/v2/org/company"

payload = {
    "name": "<string>",
    "description": "<string>",
    "twitter": "<string>",
    "linkedin": "<string>",
    "logo": "<string>",
    "productUseCases": "<string>",
    "relevanceContext": "<string>",
    "relevanceGuidelines": "<string>",
    "classificationGuidelines": "<string>",
    "competitors": "<string>",
    "companyMoat": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    twitter: '<string>',
    linkedin: '<string>',
    logo: '<string>',
    productUseCases: '<string>',
    relevanceContext: '<string>',
    relevanceGuidelines: '<string>',
    classificationGuidelines: '<string>',
    competitors: '<string>',
    companyMoat: '<string>'
  })
};

fetch('https://app.octolens.com/api/v2/org/company', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.octolens.com/api/v2/org/company",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'twitter' => '<string>',
    'linkedin' => '<string>',
    'logo' => '<string>',
    'productUseCases' => '<string>',
    'relevanceContext' => '<string>',
    'relevanceGuidelines' => '<string>',
    'classificationGuidelines' => '<string>',
    'competitors' => '<string>',
    'companyMoat' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.octolens.com/api/v2/org/company"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"linkedin\": \"<string>\",\n  \"logo\": \"<string>\",\n  \"productUseCases\": \"<string>\",\n  \"relevanceContext\": \"<string>\",\n  \"relevanceGuidelines\": \"<string>\",\n  \"classificationGuidelines\": \"<string>\",\n  \"competitors\": \"<string>\",\n  \"companyMoat\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.octolens.com/api/v2/org/company")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"linkedin\": \"<string>\",\n  \"logo\": \"<string>\",\n  \"productUseCases\": \"<string>\",\n  \"relevanceContext\": \"<string>\",\n  \"relevanceGuidelines\": \"<string>\",\n  \"classificationGuidelines\": \"<string>\",\n  \"competitors\": \"<string>\",\n  \"companyMoat\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.octolens.com/api/v2/org/company")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"twitter\": \"<string>\",\n  \"linkedin\": \"<string>\",\n  \"logo\": \"<string>\",\n  \"productUseCases\": \"<string>\",\n  \"relevanceContext\": \"<string>\",\n  \"relevanceGuidelines\": \"<string>\",\n  \"classificationGuidelines\": \"<string>\",\n  \"competitors\": \"<string>\",\n  \"companyMoat\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "status": 404,
    "details": [
      "<unknown>"
    ],
    "upgradeUrl": "https://app.octolens.com/me/upgrade?src=agents",
    "upgradeCommand": "octolens upgrade"
  }
}