CompAction

One entry in a deal's history, newest first, in the shape of the other action timelines (projects, prospects, contacts and companies): a type (note or audit), a stable event on audit rows, the note's text in details, and an opaque cursor. A deal's history has no related entities folded in, so it has no subject. Beside the shared shape: through which surface the change was made, and the old and new value of every changed field.

changes
Type:
required

The deal fields the change touched, with their old and new values; empty when the entry changed no field.

Properties: 3
cursor
Type: string
required

Opaque cursor for pagination: send it as cursor to read the entries after this one.
id
Type: string
required

Globally unique, opaque identifier of the entry.
propertyChanges
Type:
required

The property facts an edit through the deal changed, with their old and new values.

Properties: 3
timestampUtc
Type: stringFormat: date-time
required

When this happened (ISO 8601 UTC)
type
Type: string
required

note (a note on the deal) or audit (a change).
via
Type: enum
required

Through which surface the change was made.

values
appapiagentsystem
details
Type: nullable

The note's text on a note row (kind: note); null on audit rows.
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.
event
Type: null | string

Stable event name for audit rows, in resource.action notation (comp.created, comp.updated, …); null for notes.
user
Type: nullable

The user who made the change, when a person did.

Properties: 2

Comp

Company