Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / CRM

Change a person

Changes a person's fields, on every list they are on: send only what changes; null clears one. An email or LinkedIn profile another person has is refused.

patch/api/v1/people/{id}

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.
Scopescrm:write

Other ways to call it

CLItroopy people update
MCP tooltroopy_update_person
Rate limit120 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Path parameters

id*string

A 24-character id

Body

application/json
namestring | null
emailstring | null
titlestring | null
companystring | null
domainstring | null
linkedinstring | null

Their LinkedIn profile's address

phonestring | null
locationstring | null

Response

200 · application/json
data*object
18 properties
id*string

A 24-character id

name*string | null
email*string | null
emailStatus*enum<string> | null

Whether the email reaches them, once a verifier checked it

validriskyinvalidunknown

stage*enum<string> | null

Where they stand with outreach: written to, wrote back, keen, or not; null before any

contactedrepliedinterestednot_interested

linkedin*string | null

Their LinkedIn profile's address

title*string | null
phone*string | null
location*string | null
company*string | null
domain*string | null

Their company's domain

companyId*string | null

Their company's record, found by its domain

source*object

Where it first came from

3 properties
kind*enum<string>

importappapiteammateprovider

url*string | null
at*string

ISO 8601 date and time

createdBy*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
updatedBy*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
createdAt*string

ISO 8601 date and time

updatedAt*string

ISO 8601 date and time

lists*array<object>

The lists it is on

2 properties
id*string

A 24-character id

name*string

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.