Skip to main content
PATCH
Update a company

Authorizations

Authorization
string
header
required

Bearer API key. Secret server keys start with gt_live_; client-safe browser keys start with gt_pub_ (write-only, origin-pinned). Create and scope keys in Settings → API Keys.

Path Parameters

id
string
required

Resource UUID. For companies you may also pass ext:<externalId> to address by your external id.

Body

application/json

Any subset of the writable company fields. healthScore/healthStatus/counts are read-only.

name
string
Required string length: 1 - 255
domain
string | null
Maximum string length: 255
industry
string | null
Maximum string length: 100
plan
string | null
Maximum string length: 50
segment
string | null
Maximum string length: 50
region
string | null
Maximum string length: 100
location
string | null
Maximum string length: 255
lifecycleStage
string | null
Maximum string length: 30
ownerEmail
string | null
Maximum string length: 255
employeeCount
integer | null
Required range: x >= 0
arr
integer | null

Integer minor units.

Required range: x >= 0
mrr
integer | null

Integer minor units.

Required range: x >= 0
currency
string | null

ISO 4217 code or null.

Maximum string length: 3
Pattern: ^[A-Z]{3}$
contractStartDate
string<date-time> | null
contractEndDate
string<date-time> | null
autoRenew
boolean

Response

The updated company.

data
object

A canonical company record. Health, counts, and timestamps are read-only.

Last modified on July 7, 2026