Patch person

View as Markdown

Partially update person fields by id or slug using RFC 7396 JSON Merge Patch; at least one identifier is required.

Authentication

AuthorizationBearer

User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

OR
X-API-Keystring

Admin API key for system-to-system write operations

Query parameters

idstringOptionalformat: "uuid"

Owner-scoped resource UUID selector.

slugstringOptionalformat: "^[a-z0-9_-]+$"<=255 characters

Owner-scoped resource slug selector.

sourceTypeenumRequired
Write provenance source type.
sourceDetailstringRequired
Source detail or reviewer reference for the write.
sourceProviderstringOptional

Provider name for provider-native IDs or slugs.

sourceProviderIdstringOptional

Provider-native source ID.

sourceProviderSlugstringOptional

Provider-native source slug.

actorTypeenumOptional

Actor type; inferred as agent when agentChassis and agentModel are supplied, or as employee from an authenticated user JWT session.

Allowed values:
agentChassisstringOptional

Agent chassis token for agent-authored writes.

agentModelstringOptional

Agent model id for agent-authored writes.

permitMonogrambooleanOptional
Permit monogram fallbacks

Request

This endpoint expects an object.
genderstring or nullOptional
Gender
imageobject or nullOptional
Profile image object
nameFirststring or nullOptional
First name
nameLaststring or nullOptional
Last name
nameMiddlestring or nullOptional
Middle name
newSlugstring or nullOptional

Preferred detail-update slug rename field. Omit on create; when slug is also sent both fields must normalize to the same value.

nicknamestring or nullOptional
Nickname
slugstring or nullOptional

Person URL slug. Required on create; detail updates may rename through this field or newSlug.

sourceobject or nullOptional
Source workflow metadata
statusobject or nullOptional
Visibility status object
suffixstring or nullOptional
Name suffix

Response

OK
associationlist of objects
Entity associations for this person
coreobject
Canonical person core record
enrichmentobject

Supplemental person data — addresses and URL links

investmentlist of objects
Investments associated with this person
nameAliaslist of objects
Display and search aliases for this person
articleCountinteger or nullOptional
pendingApprovalinteger or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error