Skip to main content
PATCH
Update display and content fields without changing source idempotency.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Path Parameters

activityId
string
required
personId
string
required

Body

application/json
activityType
string

Activity category. Recommended values: note, call, meeting, email, message, task, event, research; custom values are allowed.

text
string

Human-readable activity text

url
string

Related URL; null clears it

data
object

Source-specific JSON object; null clears it

occurredAt
string

ISO-8601 occurrence timestamp. Null clears it and falls back to createdAt.

Response

Updated custom person activity

A custom activity attached to a resolved person

id
string

Activity ID

personId
string

Resolved person ID

activityType
string

Activity category; can be a recommended or custom value

text
string

Human-readable activity text

url
string

Related URL, when supplied

externalId
string

Source-system activity ID, when supplied

source
string

Source-system name, when supplied

data
object

Source-specific JSON object

occurredAt
string

UTC ISO-8601 occurrence timestamp; falls back to createdAt for legacy or authored activities

createdAt
string

UTC ISO-8601 creation timestamp

updatedAt
string

UTC ISO-8601 update timestamp