Skip to main content
PATCH
Update a company

Authorizations

Authorization
string
header
required

API key authentication. Generate keys from your account settings.

Include in header: Authorization: Bearer YOUR_API_KEY

Path Parameters

id
string<uuid>
required

The unique identifier of the company

Body

application/json

All fields are optional for partial updates

name
string
Maximum string length: 255
notes
string | null
company_status_id
string<uuid> | null
visibility
enum<string>
Available options:
private,
shared,
team
source
enum<string>
Available options:
manual,
email,
form,
referral,
website,
event,
other
metadata
object

Custom metadata for the company. Contains AI-extracted data, founder info, and user-configurable custom fields.

Response

Company updated successfully

success
boolean
required
Example:

true

data
object
required
authType
enum<string>
Available options:
api_key,
session