Activity

Something that happened with a company or one of its contacts: a document sent, an invoice paid, an email, a meeting, a note.

actor
Type:
required

Who made it happen.

Properties: 3
company_id
Type: integer | null
required

The company the activity belongs to: the company a document or invoice was for when it records one, otherwise the company whose activity you are reading.
contact_id
Type: integer | null
required

The contact the activity is about, or null when it is about the company itself. An activity that involved several contacts names one of them.
details
required

Facts that depend on type, or null when the type carries none.
Which field of a contact or company changed, and its values before and after.
field
Type: string
required

Name of the field that changed.

new_value
Type: string
required

Value after the change, or an empty string. A company industry, size or source reads as its display label.

old_value
Type: string
required

Value before the change, or an empty string. A company industry, size or source reads as its display label.
id
Type: string
required

Identifies the occurrence. An email thread, meeting, note or document send keeps this id wherever it appears, however many contacts it involved. Opaque: do not parse it.
occurred_at
Type: stringFormat: date-time
required

When it happened. For an email thread, the time of its latest message; for a meeting, its start.
subject
Type:
required

The record the activity is about.

Properties: 4
summary
Type: string
required

One line of plain text describing the activity.
type
Type: stringenum
required

What happened, as group.action.
values
- contact.created
- contact.updated
- contact.added_to_company
- contact.removed_from_company
- company.created
- company.updated
- company.archived
- company.restored

ActivityPropertyChangeDetails

ActivitySubject