ProspectAction

A single entry on a prospect's activity timeline. Mirrors the contact/company and project action shapes: a type (note, chat, or audit) with a type-specific details payload. With include_rollups=true, the linked Case Room's activity and the underlying contact/company notes are folded in and carry a subject identifying their origin.

cursor
Type: string

Opaque cursor for pagination.
details
Type: nullable

Type-specific details, discriminated by kind (note, chat, or audit).
Details for a note action (kind = note).
archivedAt
Type: null | stringFormat: date-time

When this note was archived (UTC, ISO 8601). Null when active. Populated for archived rows and for superseded predecessors. Only returned when include_archived=true is requested.

contentFormat
Type: null | string

Rendering format of the note body: markdown for markdown notes; null for plain text.

file
Type: nullable

Attached file information, if any.

Properties: 3
kind
enum
const:
note
message
Type: string

The note text content.

noteType
Type: null | string

Activity sub-type: call, meeting, email, news. Null for plain notes and for surfaces that carry no sub-type.

supersededByActivityId
Type: null | string

Id of the successor note that supersedes this note. Null when this note is the active head of its chain.

supersedesActivityId
Type: null | string

Id of the predecessor note this note supersedes (this note is the current revision). Null when this note is the original.
etag
Type: null | string

ETag for optimistic concurrency. Present on the prospect's own note rows — send it as the If-Match header on PATCH /api/v1/projects/{projectId}/prospects/{id}/notes/{noteId}. Null on audit rows and on entries belonging to a related room, contact, or company.
event
Type: null | string

Stable event name for type=audit rows. Null for notes.
id
Type: string

Globally-unique, opaque identifier for this action, stable across the timeline. For the prospect's own note rows it is the id accepted by PATCH /api/v1/projects/{projectId}/prospects/{id}/notes/{noteId}. Treat it as an opaque string.
subject
Type: nullable

The Case Room, contact, or company this entry belongs to. Present only when include_rollups=true; null for the prospect's own notes and events.

Properties: 3
timestampUtc
Type: stringFormat: date-time

When this action occurred (UTC).
type
Type: string

Action type: note (a user-authored note), chat, or audit (a recorded event — permanent, except that a follow-up task, a task completion and a manual stage correction can be taken back through the prospect's task and stage-override endpoints).
user
Type: nullable

User who performed this action, when known.

Properties: 2

Prospect

ProspectBatchChanges