Skip to main content
POST
Append a text activity to a resolved person.

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

personId
string
required

Body

application/json

A custom person activity

activityType
string
required

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

text
string
required

Human-readable activity text

companyId
string

Company ID. Required for PAK/API key auth; optional for JWT auth.

url
string

Optional related URL

externalId
string

Optional source-system activity ID. Deduplicates when source is also supplied.

source
string

Optional source-system name. Used with externalId as an idempotency key.

data
object

Optional source-specific JSON object, such as accountId or provider metadata

occurredAt
string

Optional ISO-8601 timestamp for when the activity occurred. Must include a UTC offset; defaults to the creation time when omitted.

Response

Custom activity added to the person

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