Skip to main content
PUT
Update a company

Authorizations

x-metal-client-id
string
header
default:<client-id>
required

The Client ID of your API key.

x-metal-api-key
string
header
default:<api-key>
required

The secret value of your API key.

Path Parameters

id
string
required

The company id.

Body

application/json

Fields to update on a company. Provide only what you want to change.

canonicalName
string
alternativeNames
string[]
website
string
description
string
shortDescription
string
sector
string
industry
string
companyType
enum<string>
Available options:
operating,
investor,
lender,
investment_bank,
advisor,
sponsor,
service_provider
externalId
string
custom
object

Response

A company.

data
object

A company record. Many attributes are populated by enrichment: Metal gathers candidate values from your documents, data providers, and the web, then ranks and reconciles them into the single value shown here. See the Enrichment and Reconciliation & ranking guides. The enrichment field exposes the discovered values and citations behind each reconciled attribute.