Skip to main content
PUT
Update Person

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Path Parameters

id
string
required

Query Parameters

mergeTags
boolean
fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Custom fields can be named too (custom followed by the capitalized name). Unknown names return 400.

Body

The fields to change. Custom fields are set as custom<Name> properties, with the CRM's field name capitalized.

The fields to change. Custom fields are set as custom<Name> properties, with the CRM's field name capitalized.

firstName
string
lastName
string
timezone
string | null
assignedUserId
string
assignedPondId
string
officeId
string
timeframeId
string
stage
string
stageId
string
emails
object[]
phones
object[]
addresses
object[]
tags
string[]
source
string
sourceId
string
systemSource
string
contactTypes
string[]
jobTitle
string
companyName
string
birthday
string
averageBeds
number
averagePrice
number
rating
number
lastActivity
string
lastActivityType
string
{key}
any

Response

A person. Custom fields come back as custom<Name> properties, with the CRM's field name capitalized.

A person. Custom fields come back as custom<Name> properties, with the CRM's field name capitalized.

id
string
required
name
string

Present unless the request's fields leaves it out.

firstName
string

Present unless the request's fields leaves it out.

lastName
string

Present unless the request's fields leaves it out.

timezone
string | null

Present unless the request's fields leaves it out.

archived
boolean | null

Present unless the request's fields leaves it out.

assignedUserId
string | null

Present unless the request's fields leaves it out.

assignedPondId
string | null

Present unless the request's fields leaves it out.

officeId
string | null

Present unless the request's fields leaves it out.

timeframeId
string | null

Present unless the request's fields leaves it out.

stage
string

Present unless the request's fields leaves it out.

stageId
string | null

Present unless the request's fields leaves it out.

tags
string[] | null

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.

created
string | null

Present unless the request's fields leaves it out.

updated
string | null

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.

addresses
object[]

Present unless the request's fields leaves it out.

emails
object[]

Present unless the request's fields leaves it out.

phones
object[]

Present unless the request's fields leaves it out.

source
string

Present unless the request's fields leaves it out.

sourceId
string | null

Present unless the request's fields leaves it out.

systemSource
string

Present unless the request's fields leaves it out.

averageBeds
number | null

Present unless the request's fields leaves it out.

averagePrice
number | null

Present unless the request's fields leaves it out.

birthday
string | null

Present unless the request's fields leaves it out.

rating
number | null

Present unless the request's fields leaves it out.

lastActivity
string | null

Present unless the request's fields leaves it out.

lastActivityType
string

Present unless the request's fields leaves it out.

contactTypes
string[]

Present unless the request's fields leaves it out.

jobTitle
string

Present unless the request's fields leaves it out.

companyName
string

Present unless the request's fields leaves it out.

Present unless the request's fields leaves it out.

{key}
any