Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Path Parameters

id
string
required

Body

application/json
name
string
Maximum string length: 255
domain
string
Maximum string length: 255
industry
string
Maximum string length: 100
size
enum<string>
Available options:
1-10,
11-50,
51-200,
201-500,
501-1000,
1001+
website
string
Maximum string length: 500
phoneNumber
string
Maximum string length: 50
addressLine1
string
Maximum string length: 255
addressLine2
string
Maximum string length: 255
addressCity
string
Maximum string length: 100
addressZip
string
Maximum string length: 20
addressCountry
string
Maximum string length: 100
notes
string
Maximum string length: 10000
ownerId
string
customFields
object

Values for the company custom fields configured under GET /crm/settings/custom-fields?recordType=company, keyed by field key. On update this is a patch: keys you do not send are left alone, and a key sent as null is removed.

vatId
string | null

VAT number (BT-48), e.g. BE0987654394

Maximum string length: 64

KBO/BCE enterprise number (BE), KvK (NL), HRB (DE) (BT-47)

Maximum string length: 64
peppolId
object | null

Peppol participant ID (BT-49) when it is not the one derivable from the registration or VAT number.

eInvoiceFormat
enum<string> | null

E-invoice format this customer receives; null = the seller's default

Available options:
zugferd-en16931,
xrechnung-cii,
peppol-bis-3,
null

Response

id
string
required
name
string
required
companyId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
domain
string
industry
string
size
enum<string>
Available options:
1-10,
11-50,
51-200,
201-500,
501-1000,
1001+
website
string
iconUrl
string

Cached brand mark, so lists can anchor on the company's own logo.

phoneNumber
string
address
object
notes
string
description
string

What the company publishes about itself. Never the seller's own notes.

ownerId
string
customFields
object
vatId
string | null
peppolId
object | null
eInvoiceFormat
object | null
owner
object
contactsCount
number
dealsCount
number
totalDealsValue
number
totalDealsCurrency
string

Majority deal currency behind totalDealsValue. Additive: older clients ignore it and keep their display fallback.