Skip to main content
PATCH
Update a company

Authorizations

Authorization
string
header
required

An Enrik API key, sent as Authorization: Bearer <key>. A key reaches public operations only, and only those whose scopes it holds. A few parameters need a scope beyond their operation’s, which the parameter names. The scopes:

  • setup:read: Read the workspace setup and its company profile.
  • setup:run: Change the setup: confirm the company profile, authorize sponsored drafting and background company research, choose what to set up and complete setup.
  • workspace:read: Read the workspace’s own profile: its health summary and setup state.
  • crm:read: Read companies with their signals, contacts and the saved views over them.
  • crm:write: Create, update and restore companies and contacts, and create, update and delete saved views.
  • crm:delete: Delete companies and contacts.
  • twin:read: Read the Company Twin: structured company knowledge and its signals.
  • discovery:read: Read ICP profiles, ICP assessments, discovery briefs, discovery jobs, candidates and the signal library.
  • discovery:write: Create and change ICP profiles, discovery briefs and signal-definition drafts, and review discovery candidates.
  • discovery:run: Create, start and cancel discovery jobs, and edit a draft one. Uses provider budget.
  • enrichment:read: Read the enrichment configuration and its results, including a record’s enrichment, formula and custom-API cells.
  • enrichment:run: Launch and cancel enrichment. Spends enrichment credits.
  • automation:read: Read workflows and agents with their run history, including a record’s agent cells.
  • automation:run: Run existing workflows and agents.
  • exports:read: Read export jobs and the fields an export can carry.
  • exports:run: Create, preview, start, cancel and archive CSV exports of companies, contacts and candidates, and download the file. Also needs crm:read. Delivering an export to a webhook destination stays in the app.
  • integrations:read: Read connections, field mappings, CRM sync jobs and webhook destinations.
  • webhooks:read: Read webhook subscriptions, the event types they can name and their delivery log.
  • webhooks:write: Subscribe a receiver URL to webhook events; edit, test, pause, resume and archive a subscription and rotate its signing secret; redeliver an event. Only workspace owners and admins can grant it.
  • reporting:read: Read analytics and dashboards.
  • assistant:read: Read the Assistant: its threads, messages and pending approvals.
  • assistant:run: Converse with the Assistant. Uses the workspace’s AI quota.
  • assistant:write: Approve or reject the changes the Assistant proposes.

Path Parameters

companyId
string<uuid>
required

The company’s id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Body

application/json

What to change on a company. A field left out keeps its value.

name
string

The new name, 1 to 120 characters. It cannot be cleared.

Required string length: 1 - 120
domain
string | null

The company’s domain, such as example.com; a URL is reduced to its host. Unique among the workspace’s live companies that are not linked to an Enrik company (canonicalCompanyId is null). A linked company is exempt: several linked companies may share a domain, also with one unlinked company. null clears it.

website
string | null

The website address; null clears it. domain is not derived from it.

Maximum string length: 2048
industry
string | null

The industry; null clears it.

Maximum string length: 255
employeeCount
integer | null

How many people the company employs; null clears it.

Required range: 0 <= x <= 2147483647
annualRevenue
number | null

The annual revenue, with at most two decimals; null clears it.

Required range: 0 <= x <= 999999999999.99
address
object

The postal address; it replaces the whole address. It is not read for city or country, which have their own fields.

linkedinUrl
string | null

The LinkedIn page address; null clears it.

Maximum string length: 2048
country
string | null

The country; null clears it.

Maximum string length: 120
summary
string | null

The description; null clears it.

Maximum string length: 5000
city
string | null

The city; null clears it.

Maximum string length: 255

The legal form; null clears it.

Maximum string length: 255
registerNumber
string | null

The commercial register number; null clears it.

Maximum string length: 255
ownerUserId
string<uuid> | null

The owning member, by user id; null clears it. List the members, and their ids, with GET /v1/workspace-members (needs crm:write).

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
customFields
object

Custom field values to set, by key; the keys left out keep their values.

expectedUpdatedAt
string<date-time>

The company’s updatedAt as you read it. When the company has changed since, the update is refused with 409 stale_version and nothing is written. Leave it out to apply the fields you send whatever changed meanwhile.

Pattern: ^((\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|(02)-(0[1-9]|1\d|2[0-8])))T([01]\d|2[0-3]):[0-5]\d(:[0-5]\d(\.\d+)?)?Z$

Response

An organisation in your workspace.

An organisation in your workspace.

id
string
required

The company’s id.

workspaceId
string
required

The workspace the company belongs to.

name
string
required

The company’s name.

domain
string | null
required

The company’s domain, such as example.com.

website
string | null
required

The website address.

industry
string | null
required

The industry.

employeeCount
integer | null
required

How many people the company employs.

Required range: -9007199254740991 <= x <= 9007199254740991
annualRevenue
number | null
required

The annual revenue.

address
object
required

The postal address, as it was given.

linkedinUrl
string | null
required

The LinkedIn page address.

country
string | null
required

The country.

ownerUserId
string | null
required

The member who owns the company, by user id. List the members, and their ids, with GET /v1/workspace-members (needs crm:write).

customFields
object
required

Custom field values, by the custom field’s key.

createdBy
string | null
required

The user who created the company; null when an API key did.

updatedBy
string | null
required

The user who changed the company last.

createdAt
string<date-time>
required

When the company was created.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
updatedAt
string<date-time>
required

When the company last changed. Send it back as expectedUpdatedAt to update safely.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
deletedAt
string<date-time> | null
required

When the company was deleted; null while it is live.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
signalSummary
object | null
required

What the company’s active signals add up to: set on a list page, null elsewhere and for a company with no signals.

summary
string | null

A short description of the company.

city
string | null

The city the company is based in.

The legal form, such as GmbH.

registerNumber
string | null

The commercial register number.

buildingEnergyTags
string[] | null

Building-energy markets the company is known to work in. Read-only.

canonicalCompanyId
string | null

The Enrik Data company this one is linked to; null when it is not. Read-only.

enrikUpdateAvailable
boolean

Whether Enrik Data has newer facts about the company than this workspace applied.

enrikSnapshotVersion
string | null

The Enrik Data version the company’s facts were last taken from.

enrichmentCells
object

With include=enrichmentCells: each enrichment column’s state for this record, by column id.

formulaCells
object

With include=formulaCells: each formula column’s state, by column id.

customApiCells
object

With include=customApiCells: each custom-API column’s state, by column id.

agentCells
object

With include=agentCells: each agent column’s state, by column id.