Skip to main content
PATCH
Update a person

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 mutable fields. You cannot move a Person to another Company. traits replaces the stored traits.

name
string
Required string length: 1 - 255
email
string<email> | null

A new address moves the whole Person: every live record of this Person takes it. 409 when another Person already uses it. null clears the address on this record only.

Maximum string length: 255
externalId
string | null
Maximum string length: 255
phone
string | null
Maximum string length: 50
role
string | null
Maximum string length: 100
contactRole
enum<string>
Available options:
decision_maker,
champion,
end_user,
billing,
influencer,
executive_sponsor,
technical,
other
isChampion
boolean
traits
object | null

Replaces the stored traits. null clears them.

linkedinUrl
string | null
Maximum string length: 2000
avatarUrl
string | null
Maximum string length: 2000

Response

The updated Person.

data
object

One Person at one Company. A Person who belongs to several Companies is returned as one record per Company, each with its own id and accountId.